Updating an Account

Function

This API is used to update an account. It can be called only from the management account of the organization.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

organizations:accounts:update

Write

account *

g:ResourceTag/<tag-key>

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
organizations:accounts:update	Write	account *	g:ResourceTag/<tag-key>	-	-

URI

PATCH /v1/organizations/accounts/{account_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
account_id	Yes	String	Definition Unique ID of an account. Constraints Mandatory Range The value must comply with the regular expression ^[\w-]+$. The value contains a maximum of 64 characters. Default Value No default value

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Definition Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Constraints N/A Range The value contains 0 to 32,768 characters. Default Value No default value

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
description	No	String	Definition Description. If you set the parameter to an empty string, the description is empty. If you set it to NULL, no operations are required. Constraints N/A Range The value contains 0 to 128 characters. Default Value No default value

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
account	AccountDto object	Definition Account details. Constraints Mandatory Range N/A Default Value No default value

**Table 5** AccountDto
Parameter	Type	Description
id	String	Definition Unique ID of an account. Constraints Mandatory Range The value must comply with the regular expression ^[\w-]+$. The value contains a maximum of 64 characters. Default Value No default value
urn	String	Definition Uniform resource name of an account. Constraints Mandatory Range The value contains 1 to 1,500 characters. Default Value No default value
join_method	String	Definition How an account joined an organization. The value can be invited (an account can be invited to join an organization) or created (an account can be directly created in an organization). Constraints Mandatory Range The value contains 1 to 64 characters. Default Value No default value
status	String	Definition Account status. It can be active, suspended, or pending_closure. Constraints Mandatory Range The value contains 1 to 64 characters. Default Value No default value
joined_at	String	Definition Date when an account joined an organization. Constraints Mandatory Range The value must be in ISO 8601 format. Default Value No default value
name	String	Definition Account name. Constraints Mandatory Range The value must comply with the regular expression ^[a-zA-Z][0-9a-zA-Z_-]+$. The value contains a maximum of 64 characters. Default Value No default value
mobile_phone	String	Definition Mobile number. Constraints None Range The value must comply with the regular expression ^1[3456789]\d{9}$. The value contains 1 to 32 characters. Default Value None
intl_number_prefix	String	Definition Prefix of a mobile number. Constraints None Range The value contains 1 to 10 characters. Default Value None
email	String	Definition Email address associated with the account. Constraints None Range The value must comply with the regular expression ^[\s][\w+=.#\|!&-]+@[\w.-]+.[\w]+[\s]$. The value contains 1 to 64 characters. Default Value None
description	String	Definition Description. Constraints N/A Range The value contains 0 to 128 characters. Default Value No default value

Example Requests

Updating an account

PATCH https://{endpoint}/v1/organizations/accounts/{account_id}

{
  "description" : "string"
}

Example Responses

Status code: 200

Successful

{
  "account" : {
    "id" : "05261f923e80d3890f33c0056e9b3f80",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:account:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/05261f923e80d3890f33c0056e9b3f80",
    "join_method" : "invited",
    "status" : "active",
    "joined_at" : "2022-08-24T06:41:15Z",
    "name" : "paas_iam_573331",
    "description" : "string"
  }
}