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

Updating an Application Account

Function

This API is used to update an application account.

Constraints

null

URI

PUT /api/v2/tenant/applications/{application_id}/accounts/{account_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

application_id

Yes

String

Application ID.

account_id

Yes

String

Application account 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

Application account name.

name

No

String

Real name.

org_code

No

String

Application organization code.

password

No

String

Password.

disabled

No

Boolean

Whether disabled.

extension

No

Object

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

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

Modify an application account information based on the application ID and application account ID. The Account field is set to Test02, the Name field is set to Example, the application organization code is 10000, and the status is enabled.

PUT https://{domain_name}/api/v2/tenant/applications/{application_id}/accounts/{account_id}

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

{
  "account_name": "Test02",
  "name":"Example",
  "org_code":"10000",
  "disabled":false
}

Example Responses

Status code: 200

Request successful.

{
  "account_id" : "20210515151018087-2F92-6DBCA6..."
}

Status Codes

Status Code

Description

200

Request successful.

400

Invalid parameter.

Error Codes

See Error Codes.