Help Center/ DataArts Lake Formation/ API Reference/ API/ LakeCat/ Credential Management/ Obtaining the Temporary Key and SecurityToken
Updated on 2024-02-21 GMT+08:00
View PDF
Share

Obtaining the Temporary Key and SecurityToken

Function

This API is used to obtain a temporary key and SecurityToken. The temporary key and SecurityToken expire after an hour or more. You need to update them before an hour passes. This API is exclusive to the tenant plane and not accessible from the management plane.

URI

POST /v1/{project_id}/instances/{instance_id}/credential

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For how to obtain the project ID, see Obtaining a Project ID (lakeformation_04_0026.xml).

instance_id

Yes

String

LakeFormation instance ID. The value is automatically generated when the instance is created, for example, 2180518f-42b8-4947-b20b-adfc53981a25.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

Array of strings

Tenant token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

user_names

No

Array of strings

IAM users.

groups

No

Array of strings

User group.

roles

No

Array of strings

Role.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

access

String

AK. An access key (AK) is used to identify a user.

secret

String

SK. A secret key (SK) is used to encrypt the signature of the access key for identity authentication.

security_token

String

SecurityToken, which is a string generated after the obtained AK and SK are encrypted.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

solution_msg

String

Solution.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

solution_msg

String

Solution.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

solution_msg

String

Solution.

Example Requests

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/credential

{
  "user_names" : [ "user1" ],
  "groups" : [ "superGroup" ],
  "roles" : [ "admin" ]
}

Example Responses

Status code: 200

OK

{
  "access" : "ABC***123",
  "secret" : "ABC***123",
  "security_token" : "abc***000"
}

Status code: 400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code": 'APIG.1002',
  "error_msg": 'Incorrect token or token resolution failed'
}

Status code: 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

Status code: 408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

Status code: 500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Credential Management