Secure Token Serviceの概要

Prev Next

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

Secure Token Service(STS)は、NAVERクラウドプラットフォームのリソースアクセスを制御するサブアカウント用の仮認証情報(Access Key、Secret Key)を発行するサービスです。Secure Token Serviceでは、サブアカウント用仮認証情報関連の APIを RETSTful形式で提供します。
Secure Token Serviceを使用して作成した仮認証情報の特徴は次の通りです。

  • サブアカウントでのみ作成できます。
  • 一部の違いを除き、永続的な Access Keyと同じ効力を持ちます。
  • 有効期限が存在します。期限切れとなった Access Keyは認識されないか、アクセスが許可されません。したがって、必要でなくなった時に交換するか、明示的に交換する必要はありません。
  • 期間制限のない Access Keyをアプリケーションにデプロイしたり、含める必要はありません。
  • 仮認証情報を作成する際、MFA認証を含めることができます。NAVERクラウドプラットフォームでは MFA手段として OTP認証を提供します。

Secure Token Serviceの共通設定

Secure Token Service APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://sts.apigw.ntruss.com

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
  • x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
  • Access Keyの発行と確認: 認証キーの作成を参照
  • サブアカウントの Access Key発行と確認: サブアカウントの作成を参照
  • x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名
  • Secret Keyの発行と確認: 認証キーの作成を参照
  • 署名の作成: シグネチャーの作成を参照
  • Content-type Required リクエストデータの形式
  • application/json
  • レスポンス

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

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

    レスポンスステータスコードの説明は次の通りです。

    HTTPステータスコード コード メッセージ 説明
    400 400 durationSecは次の範囲でのみ使用可能
    valid range: 600 - 43200: [durationSec]
    durationSec範囲指定エラー
    401 401 MultiFactorAuthentication failed with invalid MFA one time pass code 無効な OTP
    404 404 無効であるか、期限切れの認証情報 無効な認証情報
    参考

    NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

    Secure Token Service API

    Secure Token Serviceで提供する APIの説明は次の通りです。

    API 説明
    認証情報所有者の照会 Access Key所有者を照会
    認証情報の照会 サブアカウント用の仮認証情報やサブアカウント、メインアカウントの永続的な Access Keyを照会
    仮認証情報の作成 仮認証情報を作成
    仮認証情報ロールの切り替え ロール切り替えした仮認証情報を作成

    Secure Token Service関連リソース

    Secure Token Service APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。