InviteEndUser

This request will issue an invitation to a specific user, to use an environment specified by the environment policy.
If the specified policy contains multiple blueprints, the request InviteEndUserToBlueprint should be used instead, with the specific blueprint to be used included in the request.

Request URL

GET https://use.cloudshare.com/Api/v2/Admin/InviteEndUser?environmentPolicyId=<pol>&opportunity=<opportunity>&validForDays=<valid>&sendToEmail=<sendto>&firstName=<firstname>&lastName=<lastname>&UserApiId=<id>&token=<token>&timestamp=<time>&HMAC=<signature>

Parameters

environmentPolicyId The id for the environment policy
Example: PVSV2TWQQ2BA
Opportunity The name of the (business) opportunity associated with this user
Example: Op
validForDays The number of days the invitation is valid
sendToEmail Email of the user to receive the invitation
firstName Recipient user’s first name
lastName Recipient user’s last name

Response example

{
    "data": {
        "acceptUrl": "https://use.cloudshare.com/Ent/AcceptInvitation.mvc?inv=YewgwPBVXFo", 
        "detailsUrl": "https://use.cloudshare.com/Ent/Vendor/InvitationDetails.aspx?inv=YewgwPBVXFo", 
        "message": "An invitation was sent successfully"
    }, 
    "remaining_api_calls": 96, 
    "status_additional_data": null, 
    "status_code": "0x20000", 
    "status_text": "Success"
}

The response includes a link to the invitation URL sent to the recipient, and a URL with details for the sender (the vendor).

If the Usage Package contained multiple Blueprints, an error status (Invalid Action) will be returned.