Create an enterprise

POST /enterprises

Create a new enterprise, which you can use to centrally manage multiple accounts. To create an enterprise, you must have an active Subscription account. The API creates an enterprise entity, which is the root of the enterprise hierarchy. It also creates a new enterprise account that is used to manage the enterprise. All subscriptions, support entitlements, credits, and discounts from the source subscription account are migrated to the enterprise account, and the source account becomes a child account in the hierarchy. The user that you assign as the enterprise primary contact is also assigned as the owner of the enterprise account.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.enterprise.create

Auditing

Calling this method generates the following auditing event.

enterprise.enterprise.create

Request

Request Body

CreateEnterpriseRequest

The body required to create an enterprise.

source_account_id

Required *

string

The ID of the account that is used to create the enterprise.

name

Required *

string

The name of the enterprise. This field must have 3 - 60 characters.

domain

string

A domain or subdomain for the enterprise, such as `example.com` or `my.example.com`.

primary_contact_iam_id

Required *

string

The IAM ID of the enterprise primary contact, such as `IBMid-0123ABC`. The IAM ID must already exist.

Response

202 - Enterprise is now in 'PENDING' state. Enterprise state will update to 'ACTIVE' when asynchronous processing is complete

enterprise_id

string

The ID of the enterprise entity that was created. This entity is the root of the hierarchy.

enterprise_account_id

string

The ID of the enterprise account that was created. The enterprise account is used to manage billing and access to the enterprise management.

400 - Bad Request

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

List enterprises

GET /enterprises

Retrieve all enterprises for a given ID by passing the IDs on query parameters. If no ID is passed, the enterprises for which the calling identity is the primary contact are returned. You can use pagination parameters to filter the results. This method ensures that only the enterprises that the user has access to are returned. Access can be controlled either through a policy on a specific enterprise, or account-level platform services access roles, such as Administrator, Editor, Operator, or Viewer. When you call the method with the `enterprise_account_id` or `account_id` query parameter, the account ID in the token is compared with that in the query parameter. If these account IDs match, authentication isn't performed and the enterprise information is returned. If the account IDs don't match, authentication is performed and only then is the enterprise information returned in the response.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.enterprise.retrieve

Request

Path Parameters

Query Parameters

enterprise_account_id

string

Get enterprises for a given enterprise account ID.

account_group_id

string

Get enterprises for a given account group ID.

account_id

string

Get enterprises for a given account ID.

next_docid

string

The first item to be returned in the page of results. This value can be obtained from the next_url property from the previous call of the operation. If not specified, then the first page of results is returned.

limit

integer

Return results up to this limit. Valid values are between `0` and `100`.

Response

200 - Success

rows_count

integer

The number of enterprises returned from calling list enterprise

next_url

string

A string that represents the link to the next page of results

resources

array

A list of enterprise objects

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

Get enterprise by ID

GET /enterprises/{enterprise_id}

Retrieve an enterprise by the `enterprise_id` parameter. All data related to the enterprise is returned only if the caller has access to retrieve the enterprise.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.enterprise.retrieve

Request

Response

200 - Successfully retrieved enterprise by ID

url

string

The URL of the enterprise.

id

string

The enterprise ID.

enterprise_account_id

string

The enterprise account ID.

crn

string

The Cloud Resource Name (CRN) of the enterprise.

name

string

The name of the enterprise.

domain

string

The domain of the enterprise.

state

string

The state of the enterprise.

primary_contact_iam_id

string

The IAM ID of the primary contact of the enterprise, such as `IBMid-0123ABC`.

primary_contact_email

string

The email of the primary contact of the enterprise.

source_account_id

string

The ID of the account that is used to create the enterprise.

created_at

string

The time stamp at which the enterprise was created.

created_by

string

The IAM ID of the user or service that created the enterprise.

updated_at

string

The time stamp at which the enterprise was last updated.

updated_by

string

The IAM ID of the user or service that updated the enterprise.

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

404 - Not Found

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

Update an enterprise

PATCH /enterprises/{enterprise_id}

Update the name, domain, or IAM ID of the primary contact for an existing enterprise. The new primary contact must already be a user in the enterprise account.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.enterprise.update

Auditing

Calling this method generates the following auditing event.

enterprise.enterprise.update

Request

Request Body

UpdateEnterpriseRequest

Parameters to update the enterprise.

name

string

The new name of the enterprise. This field must have 3 - 60 characters.

domain

string

The new domain of the enterprise. This field has a limit of 60 characters.

primary_contact_iam_id

string

The IAM ID of the user to be the new primary contact for the enterprise.

Response

204 - Success

400 - Bad Request. The payload passed to the request is invalid.

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

404 - Not Found

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

Import an account into an enterprise

PUT /enterprises/{enterprise_id}/import/accounts/{account_id}

Import an existing stand-alone account into an enterprise. The existing account can be any type: trial (`TRIAL`), Lite (`STANDARD`), Pay-As-You-Go (`PAYG`), or Subscription (`SUBSCRIPTION`). In the case of a `SUBSCRIPTION` account, the credits, promotional offers, and discounts are migrated to the billing unit of the enterprise. For a billable account (`PAYG` or `SUBSCRIPTION`), the country and currency code of the existing account and the billing unit of the enterprise must match. The API returns a `202` response and performs asynchronous operations to import the account into the enterprise. For more information about impacts to the account, see Adding accounts to an enterprise.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.enterprise.import

Auditing

Calling this method generates the following auditing event.

enterprise.enterprise.import

Request

Request Body

ImportToEnterpriseRequest

The body of the request to import an account into the enterprise.

parent

string

The CRN of the expected parent of the imported account. The parent is the enterprise or account group that the account is added to.

billing_unit_id

string

The ID of the billing unit to use for billing this account in the enterprise.

Response

202 - The request was accepted and the account was imported into the enterprise. After the account’s billing unit is updated to the enterprise’s, the asynchronous process is complete.

401 - Invalid Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

404 - Not Found

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

Create an account group

POST /account-groups

Create a new account group, which can be used to group together multiple accounts. To create an account group, you must have an existing enterprise. The API creates an account group entity under the parent that is specified in the payload of the request. The request also takes in the name and the primary contact of this new account group.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.account-group.create

Auditing

Calling this method generates the following auditing event.

enterprise.account-group.create

Request

Request Body

CreateAccountGroupRequest

The body that is required to create an account group.

parent

Required *

string

The CRN of the parent under which the account group will be created. The parent can be an existing account group or the enterprise itself.

name

Required *

string

The name of the account group. This field must have 3 - 60 characters.

primary_contact_iam_id

Required *

string

The IAM ID of the primary contact for this account group, such as `IBMid-0123ABC`. The IAM ID must already exist.

Response

201 - Create account group request completed successfully.

account_group_id

string

The ID of the account group entity that was created.

400 - Bad Request

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

List account groups

GET /account-groups

Retrieve all account groups based on the values that are passed in the query parameters. If no query parameter is passed, all of the account groups in the enterprise for which the calling identity has access are returned. You can use pagination parameters to filter the results. The `limit` field can be used to limit the number of results that are displayed for this method. This method ensures that only the account groups that the user has access to are returned. Access can be controlled either through a policy on a specific account group, or account-level platform services access roles, such as Administrator, Editor, Operator, or Viewer. When you call the method with the `enterprise_id`, `parent_account_group_id` or `parent` query parameter, all of the account groups that are immediate children of this entity are returned. Authentication is performed on all account groups before they are returned to the user to ensure that only those account groups are returned to which the calling identity has access.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.account-group.retrieve

Request

Path Parameters

Query Parameters

enterprise_id

string

Get account groups that are either immediate children or are a part of the hierarchy for a given enterprise ID.

parent_account_group_id

string

Get account groups that are either immediate children or are a part of the hierarchy for a given account group ID.

next_docid

string

parent

string

Get account groups that are either immediate children or are a part of the hierarchy for a given parent CRN.

limit

integer

Return results up to this limit. Valid values are between `0` and `100`.

include_deleted

boolean

Include the deleted account groups from an enterprise when used in conjunction with other query parameters.

Response

200 - Success

rows_count

integer

The number of enterprises returned from calling list account groups

next_url

string

A string that represents the link to the next page of results

resources

array

A list of account groups

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

Get account group by ID

GET /account-groups/{account_group_id}

Retrieve an account by the `account_group_id` parameter. All data related to the account group is returned only if the caller has access to retrieve the account group.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.account-group.retrieve

Request

Response

200 - Successfully retrieved account group by ID.

url

string

The URL of the account group.

id

string

The account group ID.

crn

string

The Cloud Resource Name (CRN) of the account group.

parent

string

The CRN of the parent of the account group.

enterprise_account_id

string

The enterprise account ID.

enterprise_id

string

The enterprise ID that the account group is a part of.

enterprise_path

string

The path from the enterprise to this particular account group.

name

string

The name of the account group.

state

string

The state of the account group.

primary_contact_iam_id

string

The IAM ID of the primary contact of the account group.

primary_contact_email

string

The email address of the primary contact of the account group.

created_at

string

The time stamp at which the account group was created.

created_by

string

The IAM ID of the user or service that created the account group.

updated_at

string

The time stamp at which the account group was last updated.

updated_by

string

The IAM ID of the user or service that updated the account group.

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

404 - Not Found

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

Update an account group

PATCH /account-groups/{account_group_id}

Update the name or IAM ID of the primary contact for an existing account group. The new primary contact must already be a user in the enterprise account.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.account-group.update

Auditing

Calling this method generates the following auditing event.

enterprise.account-group.update

Request

Request Body

UpdateAccountGroupRequest

The ID of the account group to update.

name

string

The new name of the account group. This field must have 3 - 60 characters.

primary_contact_iam_id

string

The IAM ID of the user to be the new primary contact for the account group.

Response

204 - Success

400 - Bad Request. The payload passed to the request is invalid.

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

404 - Not Found

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

Delete an account group from the enterprise

DELETE /account-groups/{account_group_id}

Delete an existing account group from the enterprise. You can't delete an account group that has child account groups, the delete request will fail. This API doesn't perform a recursive delete on the child account groups, it only deletes the current account group.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.account-group.delete

Auditing

Calling this method generates the following auditing event.

enterprise.account-group.delete

Request

Response

204 - Successfully removed the account group from the enterprise.

400 - Bad Request.

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

404 - Not Found

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

Create a new account in an enterprise

POST /accounts

Create a new account as a part of an existing enterprise. The API creates an account entity under the parent that is specified in the payload of the request. The request also takes in the name and the owner of this new account. The owner must have a valid IBMid that's registered with IBM Cloud, but they don't need to be a user in the enterprise account.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.account.create

Auditing

Calling this method generates the following auditing event.

enterprise.account.create

Request

Request Body

CreateAccountRequest

The body required to create a new account.

parent

Required *

string

The CRN of the parent under which the account will be created. The parent can be an existing account group or the enterprise itself.

name

Required *

string

The name of the account. This field must have 3 - 60 characters.

owner_iam_id

Required *

string

The IAM ID of the account owner, such as `IBMid-0123ABC`. The IAM ID must already exist.

traits

object

The traits object can be used to set properties on child accounts of an enterprise. You can pass a field to opt-out of the default multi-factor authentication setting or enable enterprise-managed IAM when creating a child account in the enterprise. This is an optional field.

mfa

string

By default MFA is set to `NONE_NO_ROPC` on a child account, which disables CLI logins with only a password. To opt out, pass the traits object with the mfa field set to empty string. This is an optional field.

enterprise_iam_managed

boolean

By default enterprise-managed IAM is turned off for a newly created child account. You can enable this property by passing 'true' in this boolean field. Enabling enterprise-managed IAM allows the enterprise account to assign IAM resources, like access groups, trusted profiles, and account settings, to the child account. This is an optional field.

options

object

The options object can be used to set properties on child accounts of an enterprise. You can pass a field to to create IAM service id with IAM api keyg when creating a child account in the enterprise. This is an optional field.

create_iam_service_id_with_apikey_and_owner_policies

boolean

By default create_iam_service_id_with_apikey_and_owner_policies is turned off for a newly created child account. You can enable this property by passing 'true' in this boolean field. IAM service id has account owner IAM policies and the API key associated with it can generate a token and setup resources in the account. This is an optional field.

Response

202 - The create account request completed successfully

account_id

string

The ID of the account entity that was created.

iam_service_id

string

The iam_service_id of the account entity that was created.

iam_apikey_id

string

The iam_apikey_id of the account entity that was created.

iam_apikey

string

The iam_apikey of the account entity with owner iam policies that was created.

400 - Bad Request

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

List accounts

GET /accounts

Retrieve all accounts based on the values that are passed in the query parameters. If no query parameter is passed, all of the accounts in the enterprise for which the calling identity has access are returned. You can use pagination parameters to filter the results. The `limit` field can be used to limit the number of results that are displayed for this method. This method ensures that only the accounts that the user has access to are returned. Access can be controlled either through a policy on a specific account, or account-level platform services access roles, such as Administrator, Editor, Operator, or Viewer. When you call the method with the `enterprise_id`, `account_group_id` or `parent` query parameter, all of the accounts that are immediate children of this entity are returned. Authentication is performed on all the accounts before they are returned to the user to ensure that only those accounts are returned to which the calling identity has access to.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.account.retrieve

Request

Path Parameters

Query Parameters

enterprise_id

string

Get accounts that are either immediate children or are a part of the hierarchy for a given enterprise ID.

account_group_id

string

Get accounts that are either immediate children or are a part of the hierarchy for a given account group ID.

next_docid

string

parent

string

Get accounts that are either immediate children or are a part of the hierarchy for a given parent CRN.

limit

integer

Return results up to this limit. Valid values are between `0` and `100`.

include_deleted

boolean

Include the deleted accounts from an enterprise when used in conjunction with enterprise_id.

Response

200 - Success

rows_count

integer

The number of enterprises returned from calling list accounts

next_url

string

A string that represents the link to the next page of results

resources

array

A list of accounts

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

Get account by ID

GET /accounts/{account_id}

Retrieve an account by the `account_id` parameter. All data related to the account is returned only if the caller has access to retrieve the account.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.account.retrieve

Request

Response

200 - Successfully retrieved account by ID

url

string

The URL of the account.

id

string

The account ID.

crn

string

The Cloud Resource Name (CRN) of the account.

parent

string

The CRN of the parent of the account.

enterprise_account_id

string

The enterprise account ID.

enterprise_id

string

The enterprise ID that the account is a part of.

enterprise_path

string

The path from the enterprise to this particular account.

name

string

The name of the account.

state

string

The state of the account.

owner_iam_id

string

The IAM ID of the owner of the account.

paid

boolean

The type of account - whether it is free or paid.

owner_email

string

The email address of the owner of the account.

is_enterprise_account

boolean

The flag to indicate whether the account is an enterprise account or not.

created_at

string

The time stamp at which the account was created.

created_by

string

The IAM ID of the user or service that created the account.

updated_at

string

The time stamp at which the account was last updated.

updated_by

string

The IAM ID of the user or service that updated the account.

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

404 - Not Found

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

Move an account within the enterprise

PATCH /accounts/{account_id}

Move an account to a different parent within the same enterprise.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.account.move

Auditing

Calling this method generates the following auditing event.

enterprise.account.move

Request

Request Body

MoveAccountRequest

The ID of the account to move.

parent

Required *

string

The CRN of the new parent within the enterprise.

Response

202 - Moving account process is in PENDING state. After the parent field of the account shows the new parent, asynchronous processing is complete.

204 - Update Successful

400 - Bad Request. The payload passed to the request is invalid.

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

404 - Not Found

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

Remove an account from its enterprise

DELETE /accounts/{account_id}

Remove an account from the enterprise that it's currently in. After an account is removed, it is canceled and cannot be reactivated.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

enterprise.account.delete

Auditing

Calling this method generates the following auditing event.

enterprise.account.delete

Request

Response

204 - Successfully removed the account from the enterprise.

400 - Bad Request

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

401 - Invalid or Expired Access Token

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

403 - Access Denied

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

404 - Not Found

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

500 - Internal Server Error

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user

503 - Service Unavailable

trace

string

The `transaction-id` of the request

errors

array

Array of error which contains the code and message for an error returned to the user