Help Center/ OneAccess/ API Reference/ OneAccess APIs/ Management APIs/ Application Account Management/ Adding an Application Account
Updated on 2024-12-30 GMT+08:00
View PDF
Share

Adding an Application Account

Function

This API is used to create an application account for a user and grant permissions to them.

Constraints

null

URI

POST /api/v2/tenant/applications/{application_id}/accounts/basic-account

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

application_id

Yes

String

Application ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Set this field to "application/json;charset=utf8".

Authorization

Yes

String

Authentication credential. The value is "Bearer {access_token}". access_token is obtained by calling the API for obtaining an access credential.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

user_id

Yes

String

ID of the authorized user that is associated with the application account.

account_name

No

String

Application account name. If the parameter is left blank, the username is used by default.

name

No

String

Real name.

org_code

No

String

Application organization code.

password

No

String

Application account password.

disabled

No

Boolean

Whether the application account is disabled. If the parameter is left blank, the application account is enabled by default.

extension

No

Object

Custom extended attributes, which can be customized by choosing "Object Models" > "Application Accounts".

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

account_id

String

Application account ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error details.

Example Requests

Create an account for the application and associate specified users to it. The Account field is set to zhangshan, the Name field is set to zs, and ID of the associated user is 20220331164602949-904C-D475B60AE. The application account is enabled.

POST https://{domain_name}/api/v2/tenant/applications/{application_id}/accounts/basic-account

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...

{
    "account_name":"zhangsan",
    "user_id":"20220331164602949-904C-D475B60AE",
    "name":"zs",
    "org_code":"",
    "password":"",
    "disabled":false,
    "extension":{}
}

Example Responses

Status code: 201

Request successful.

{
  "account_id" : "20210517100458591-6F1C-965A4C..."
}

Status Codes

Status Code

Description

201

Request successful.

400

Invalid parameter.

Error Codes

See Error Codes.