OPTIONS /api/v3/invitations

This request returns a list of environment policies available to the user. An environment policy is a combination of project and blueprint, both of which are necessary to use an environment. Using information in this list, the user can request an invitation to use an environment, and send this information to other users.

If no parameters are included in the request, all environment polices available to the user are returned. If values for project or blueprint are included, the returned list will be filtered accordingly.

OPTIONS /api/v3/invitations?projectNameFilter=<projectName>&blueprintNameFilter=<blueprintName>&policyNameFilter=<policyName>

Request Payload

None

Parameters

ProjectNameFilter Filter options irrelevant to the specified project
BlueprintNameFilter Filter options irrelevant to the specified blueprint
PolicyNameFilter Filter options irrelevant to the specified environment policy

Response examples

{
    "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"
            ]
        }
    ]
}