Invitations

Invitations are used to give users access to an account

Create an invitation

post/invitations
Request
Security:
header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Request Body schema: application/json
email
required
string <email>

Email address to send the invitation to

roleID
required
string^[a-z0-9-]+$

The role associated with the invitation

Responses
201

The invitation has been created.

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Request samples
application/json
{
  • "email": "user.one@example.com",
  • "roleID": "full-access"
}
Response samples
application/json
{
  • "id": "3FDCA1955AE7EB167B25D7D90AC02B9F",
  • "email": "user.one@example.com",
  • "roleID": "full-access",
  • "state": "invited",
  • "created": "2020-06-21T09:01:12Z",
  • "lastModified": "2020-07-10T07:02:10Z",
  • "expiry": "2020-07-10T07:02:10Z",
  • "lastSent": "2020-07-10T07:02:10Z",
  • "urn": "urn:cloudone:identity:ca-1:012345678912:invitation/3FDCA1955AE7EB167B25D7D90AC02B9F"
}

List invitations sent from an account

get/invitations/sent
Request
Security:
query Parameters
cursor
string

An encoded value used to retrieve the next set of results for a query that returns more than limit results.

Example: cursor=3FDCA1955AE7EB167B25D7D90AC02B9
limit
integer

The maximum numbers of records to return. If zero, the request will use the default limit 25. If negative, the request will be rejected.

Example: limit=10
header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

The response body contains the invitations.

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Response samples
application/json
{
  • "next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo=",
  • "invitations": [
    ]
}

Describe an invitation sent from an account

get/invitations/sent/{id}
Request
Security:
path Parameters
id
required
string

The invitation ID.

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

The response body contains the invitation details.

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

404

The resource you were looking for doesn't exist.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Response samples
application/json
{
  • "id": "3FDCA1955AE7EB167B25D7D90AC02B9F",
  • "email": "user.one@example.com",
  • "roleID": "full-access",
  • "state": "invited",
  • "created": "2020-06-21T09:01:12Z",
  • "lastModified": "2020-07-10T07:02:10Z",
  • "expiry": "2020-07-10T07:02:10Z",
  • "lastSent": "2020-07-10T07:02:10Z",
  • "urn": "urn:cloudone:identity:ca-1:012345678912:invitation/3FDCA1955AE7EB167B25D7D90AC02B9F"
}

Modify an invitation sent from an account

post/invitations/sent/{id}

Invitations in the invited state can be revoked by sending a request with the desired new state, or resent by sending a POST with no request body.

Request
Security:
path Parameters
id
required
string

The invitation ID.

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Request Body schema: application/json
state
string

The current state of the invitation

Enum: "invited" "accepted" "rejected" "revoked"
Responses
200

The response body contains the invitation details.

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

404

The resource you were looking for doesn't exist.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Request samples
application/json
{
  • "state": "invited"
}
Response samples
application/json
{
  • "email": "user.one@example.com",
  • "roleID": "full-access"
}