Support Open Console

Accounts

Accounts are where all the security service information is stored, they can be accessed by users who have a role in that account

Describe an account

get/accounts/{id}
Request
Security:
path Parameters
id
required
string 12 characters

The account ID.

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

The response body contains the account 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": "012345678912",
  • "alias": "Trend Micro Cloud One",
  • "locale": "en",
  • "timezone": "America/Toronto",
  • "region": "us-1",
  • "state": "active",
  • "created": "2020-06-21T09:01:12Z",
  • "lastModified": "2020-07-10T07:02:10Z",
  • "urn": "urn:cloudone:identity:ca-1:012345678912:account/012345678912",
  • "mfaRequired": true,
  • "links": []
}

Modify an account

post/accounts/{id}
Request
Security:
path Parameters
id
required
string 12 characters

The account ID.

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Request Body schema: application/json
alias
required
string

The account's alias

locale
required
string

Locale of account, used for localization

mfaRequired
boolean

Indicates if users must have Multi-Factor Authentication enabled to login to this account. Default 'false' if not set on creation.

region
required
string

Region of the account. Account data is restricted to this region. Not modifiable.

Value: "us-1"
timezone
required
string

Timezone of account, used to display local dates and times

Responses
200

The response body contains the account 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
{
  • "alias": "Trend Micro Cloud One",
  • "locale": "en",
  • "timezone": "America/Toronto",
  • "region": "us-1",
  • "mfaRequired": true
}
Response samples
application/json
{
  • "id": "012345678912",
  • "alias": "Trend Micro Cloud One",
  • "locale": "en",
  • "timezone": "America/Toronto",
  • "region": "us-1",
  • "state": "active",
  • "created": "2020-06-21T09:01:12Z",
  • "lastModified": "2020-07-10T07:02:10Z",
  • "urn": "urn:cloudone:identity:ca-1:012345678912:account/012345678912",
  • "mfaRequired": true,
  • "links": []
}

Delete an account

delete/accounts/{id}

Set an account to be deleted in 30 days

Request
Security:
path Parameters
id
required
string 12 characters

The account ID.

header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
202

The request to delete the account has been accepted, and the account will be 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": "Account is suspended and will be deleted in 30 days, please contact support if you want to recover this account"
}