認証情報の照会

Classic/VPC環境で利用できます。

Secure Token Serviceで作成したサブアカウント用の仮認証情報(Access Key、Secret Key)を照会したり、サブアカウント、メインアカウントの永続的な Access Keyを照会します。

参考

Secure Token Serviceを使用してサブアカウント用の仮認証情報を作成する方法は、仮認証情報の作成をご参照ください。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v1/credentials

リクエストヘッダ

Secure Token Service APIで共通して使用されるヘッダの詳細は、Secure Token Serviceのリクエストヘッダをご参照ください。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://sts.apigw.ntruss.com/api/v1/credentials' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`accessKey`	String	-	Access Key
`keySecret`	String	-	Secret Key 仮認証情報の照会時に表示
`createTime`	String	-	作成日 ISO 8601形式
`expireTime`	String	-	有効期限仮認証情報の照会時に表示 ISO 8601形式
`useMfa`	Boolean	-	MFA認証を設定するかどうか仮認証情報の照会時に表示 `true` \| `false` `true`: 設定 `false`: 設定しない

レスポンスステータスコード

Secure Token Service APIで共通して使用されるレスポンスステータスコードの詳細は、Secure Token Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "accessKey": "ncp_iam_***************",
    "keySecret": "ncp_iam_**********************",
    "createTime": "2024-10-10T16:58:28Z",
    "expireTime": "2024-10-10T17:58:28Z",
    "useMfa": false
}