Help Center> Organizations> API Reference> API> Managing Accounts> Creating an Account

Updated on 2024-03-15 GMT+08:00

View PDF

Creating an Account

Function

This API is used to create an account. The generated account automatically becomes a member account of the organization holding the account that calls this API. This API can be called only from the organization's management account. The Organizations service creates the required service-linked agency and account-accessed agency in the new account.

URI

POST /v1/organizations/accounts

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Minimum: 1

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Account name. Maximum: 64
email	No	String	Email address. Minimum: 1 Maximum: 64
phone	No	String	Mobile number. Minimum: 1 Maximum: 32
agency_name	No	String	Agency name. Minimum: 1 Maximum: 32
tags	No	Array of TagDto objects	List of tags you want to attach to the new account.

**Table 3** TagDto
Parameter	Mandatory	Type	Description
key	Yes	String	Identifier or name of the tag key. Minimum: 1 Maximum: 128
value	Yes	String	String value associated with the tag key. You can set the tag value to an empty string, but cannot set it to NULL. Minimum: 0 Maximum: 255

Response Parameters

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
create_account_status	CreateAccountStatusDto object	States of CreateAccount requests for an organization.

**Table 5** CreateAccountStatusDto
Parameter	Type	Description
account_id	String	Unique ID of the newly created account if any. Maximum: 36
account_name	String	Account name. Maximum: 64
completed_at	String	Date and time when the account was created and the request was completed.
created_at	String	Date and time when the CreateAccount request was made.
id	String	Unique ID of a request. You can get this value from the response to the initial CreateAccount request. Maximum: 36
state	String	Status of the asynchronous request for creating an account. Minimum: 1 Maximum: 64
failure_reason	String	Reason for a request failure.

Example Requests

Creating an account

POST https://{hostname}/v1/organizations/accounts

{
  "name" : "C9Qzukfn6FIyxAmC3dQclrwZW34UDu_rPSRrCQ4aGFm0-r1zC2RDHt5oHA-aY21B",
  "tags" : [ {
    "key" : "keystring",
    "value" : "valuestring"
  } ]
}

Example Responses

Status code: 202

Successful

{
  "create_account_status" : {
    "account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
    "account_name" : "paas_iam_573331",
    "completed_at" : "2022-08-24T06:41:15Z",
    "created_at" : "2022-08-24T06:41:15Z",
    "id" : "h-awjp43m7bz3b8jgy5v61jrfwakt3og8w",
    "state" : "in_progress",
    "failure_reason" : "string"
  }
}