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

Authorizing an Application Account

Function

This API is used to grant the application access permission to a user and create an application account for the user in the application.

Constraints

null

URI

POST /api/v2/tenant/users/{user_id}/applications/{application_id}/accounts

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

user_id

Yes

String

User ID.

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

account_name

No

String

(Optional) Name of the application account created in the application for the user. The value can be null, which means the username is used by default.

Response Parameters

Status code: 200

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

Authorize an application account named Test01 by creating it for the application ID.

POST https://{domain_name}/api/v2/tenant/users/{user_id}/applications/{application_id}/accounts

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

{
    "account_name":"Test01"
}

Example Responses

Status code: 200

Request successful.

{
  "account_id" : "20210621095931341-4CB3-122995..."
}

Status Codes

Status Code

Description

200

Request successful.

400

Invalid parameter.

Error Codes

See Error Codes.

Parent topic: User Management