OPTIONS /api/v3/invitations

Returns policies, blueprints and project member users available to the requesting user. These entities are specified when requesting end user invitations.

Request Path

OPTIONS /api/v3/invitations?projectNameFilter={projectName}&blueprintNameFilter={blueprintName}&policyNameFilter={policyName}

Request Payload

None

Parameters

plrojectNameFilter Optional. Specifies only to return results that belong to the specified project, where {projectName} is name of the project.
blueprintNameFilter Optional. Specifies to return only options that are relevant to the specified blueprint, where {blueprintName} is the name of the blueprint.
policyNameFilter Optional. Specifies to return only options that are relevant to the specified environment policy, where {policyName} is the name of the policy.

Response Example

{
    "envPoliciesList": [
        {
            "id": "POLs3J1NEAESn7ipYMwYq20Q2",
            "name": "24 hours",
            "projectId": "PRjTcEu83MXmpDAHTf47b-QQ2",
            "projectName": "Testing project",
            "organizations": [
                "CloudShare"
            ],
            "blueprints": [
                {
                    "id": "BPitsTtiUS27hEsHcVZcZsxw2",
                    "name": "Testing Sample",
                    "regions": [
                       "REKolD1-ab84YIxODeMGob9A2"
                    ]
                }
            ]
        }
    ],
    "owningProjectMembers": [
        {
            "id": "VPJMmaEFfIsTCoVGBjZtpRgw2",
            "name": "Jayden Inigo",
            "email": "JaydenInigo@cloudshare.com",
            "organizations": [
                "CloudShare"
            ]
        }
    ]
}