Configuring Authorization¶

Function¶

This API is used to configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services can be properly used only after required permissions are assigned. The administrator can use this API to configure an agency for IAM users and configure the access key of the current user.

URI¶

POST /v2/{project_id}/authorizations

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID and Name.

Request Parameters¶

**Table 2** Request body parameters¶
Parameter	Mandatory	Type	Description
user_id	No	String	User ID. For details about how to obtain a user ID, see Obtaining a User ID. If user_id is set to all, all IAM users are authorized. If some IAM users have been authorized, the authorization setting will be updated. This parameter is mandatory only if the authorization method is set to Agency.
type	No	String	Authorization type. Agency is recommended. Options: agency: authorization through an agency credential: authorization through an access Key (AK/SK)
content	Yes	String	Authorization content. If Authorization Type is set to Agency, this field indicates the agency name. If Authorization Type is set to AK/SK, this field indicates the access key ID (AK).
secret_key	No	String	Secret Access Key (SK). This field is required only when Authorization Method is set to AK/SK.
user_name	No	String	Username. If user_id is set to all-users, all users will be displayed.

Response Parameters¶

None

Example Requests¶

The following is an example of how to upload authorization whose authorization type is agency and authorization content is modelarts_agency.

POST https://{endpoint}/v2/{project_id}/authorizations

{
  "user_id" : "****d80fb058844ae8b82aa66d9fe****",
  "type" : "agency",
  "content" : "modelarts_agency"
}

Example Responses¶

Status code: 200

{
  "result" : "true"
}

Status Codes¶

Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found

Error Codes¶

See Error Codes.

last updated: 2024-12-11 13:55 UTC - commit: afb4a7dfa15e256dc933e946d9e874db041cb35c