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.
Request URL
GET https://use.cloudshare.com/Api/v2/Admin/InviteEndUserOptions?projectFilter=<project>&blueprintFilter=<blueprint>&envPolicyDurationFilter=<policy>&token=<token>×tamp=<time>&UserApiId=<id>&HMAC=<signature>
Parameters
projectFilter optional |
A name of a specific project, to filter the result list. Example: Automation |
blueprintFilter optional |
A name of a specific blueprint, to filter the result list. Example: automation |
envPolicyDurationFilter optional |
A name of a specific environment policy duration to filter the result list. Example: Automation (5d) |
Response example
{ "data": { "AvailableOwningProjectMembersList": [ { "Email": "jsmith@company.com", "Name": "j smith", "Organizations": [ "CloudShare" ], "OwningProjectMemberId": "MHURFL02DNVB" } ], "EnvPoliciesList": [ { "Blueprints": [ { "BlueprintId": "TXRICZURB1TA", "Name": "CloudShare Documentation linux proto" } ], "EnvPolicyDuration": "PoC (10 days)", "EnvPolicyId": "T0JCP2VQ1XHA", "Organizations": [ "CloudShare" ], "Project": " Documentation Project" }, { "Blueprints": [ { "BlueprintId": "LWD0GW52CEJA", "Name": "linux environment" } ], "EnvPolicyDuration": "PoC (10 days)", "EnvPolicyId": "GSMKV44JETNA", "Organizations": [ "CloudShare" ], "Project": " Documentation Project" }, { "Blueprints": [ { "BlueprintId": "RG1DSAXBFEJB", "Name": "newProto" } ], "EnvPolicyDuration": "PoC (10 days)", "EnvPolicyId": "SY1FYBBEUMGB", "Organizations": [ "CloudShare" ], "Project": " Documentation Project" }, { "Blueprints": [ { "BlueprintId": "OYIMU2LFXLXA", "Name": "Linux2" } ], "EnvPolicyDuration": "PoC (10 days)", "EnvPolicyId": "RACFFKXJPD4B", "Organizations": [ "CloudShare" ], "Project": " Documentation Project" }, { "Blueprints": [ { "BlueprintId": "GJSQ4WLEBT0B", "Name": "Blueprint1" } ], "EnvPolicyDuration": "PoC (10 days)", "EnvPolicyId": "JHGNJFQS4MOA", "Organizations": [ "CloudShare" ], "Project": " Documentation Project" }, { "Blueprints": [ { "BlueprintId": "T3AL42LH4C2A", "Name": "Blueprint1" } ], "EnvPolicyDuration": "PoC (10 days)", "EnvPolicyId": "YQBJUNN1I2IA", "Organizations": [ "CloudShare" ], "Project": " Documentation Project" } ] }, "remaining__calls": 99992, "status_additional_data": null, "status_code": "0x20000", "status_text": "Success" }
The response will include a list of Project Members available to the user, as well as a list of policies that can be used for invitations. The policies are a combination of project, blueprints and resource packages; there can be more than one blueprint associated with a project.