Support Open Console

Users

Users are persons with access to one or more accounts

List users within an account

get/users
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
roleID
string^([a-z][a-z]*)(-[a-z]+)*$

When present, the roleID query parameter will filter the list of users to those where the roleID exactly matches the provided value.

Example: roleID=full-access
header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

The response body contains the users.

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=",
  • "users": [
    ]
}

Describe a user within an account

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

The user ID.

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

The response body contains the user 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": "cc401d8f-7920-4d03-9e48-ce8ef79b4835",
  • "name": "Jon Smith",
  • "email": "user.one@example.com",
  • "roleID": "full-access",
  • "locale": "en",
  • "timezone": "America/Toronto",
  • "state": "enabled",
  • "mfaEnabled": true,
  • "created": "2020-06-21T09:01:12Z",
  • "lastModified": "2020-06-21T09:01:12Z",
  • "lastActivity": "2020-08-10T07:02:10Z",
  • "urn": "urn:cloudone:identity:ca-1:012345678912:user/cc401d8f-7920-4d03-9e48-ce8ef79b4835"
}

Modify a user within an account

post/users/{id}
Request
Security:
path Parameters
id
required
string

The user ID.

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Request Body schema: application/json
roleID
required
string^([a-z][a-z]*)(-[a-z]+)*$

The user's role identifier in the account

state
string

Indicates if a user is currently active or not

Enum: "enabled" "disabled"
Responses
200

The response body contains the user 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
{
  • "roleID": "full-access",
  • "state": "enabled"
}
Response samples
application/json
{
  • "id": "cc401d8f-7920-4d03-9e48-ce8ef79b4835",
  • "name": "Jon Smith",
  • "email": "user.one@example.com",
  • "roleID": "full-access",
  • "locale": "en",
  • "timezone": "America/Toronto",
  • "state": "enabled",
  • "mfaEnabled": true,
  • "created": "2020-06-21T09:01:12Z",
  • "lastModified": "2020-06-21T09:01:12Z",
  • "lastActivity": "2020-08-10T07:02:10Z",
  • "urn": "urn:cloudone:identity:ca-1:012345678912:user/cc401d8f-7920-4d03-9e48-ce8ef79b4835"
}

Delete user from an account

delete/users/{id}

Removes the user from an account, and removes their access to the account

Request
Security:
path Parameters
id
required
string

The user ID.

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
204

The user has been deleted.

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
{
  • "message": "Something went wrong."
}