Create Account

POST 
/v2/account

Create an account in an organization.Requires accountOrg:config:edit or account:config:edit permissions and to share an org with the account

Request

Query Parameters

m2m M2M

Create a Machine-To-Machine account for the organization.

application/json

Body

required

account_email email

Email address for this account. Ignored if creating an M2M account.

description Description (string)

Description for this account

name Name (string)

Name for this account. Ignored if creating an M2M account.

org_id uuidrequired

Organization ID for this account

client_secret Client Secret (string)

Client secret for this M2M account. One is generated if this is left blank.

password Password (string)

Password for this account. Ignored if creating an M2M account.

Responses

200

Successful Response

application/json

Schema

Schema

description Description (string)

Description for this account

org_id uuid

Organization ID for this account

account_id uuidrequired

Account ID

account_email email

Email address for this account

client_secret Client Secret (string)

Client secret for this account

Example (from schema)

{
  "description": "string",
  "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "account_email": "user@example.com",
  "client_secret": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...