アクセス・トークン・フローの作成
投稿
/oauth2/rest/token
リクエスト
サポートされているメディア・タイプ
- application/x-www-form-urlencoded
問合せパラメータ
- identityDomain(optional): string
トークンをリクエストしているアイデンティティ・ドメイン。'x-oauth-identity-domain-name'ヘッダー・パラメータが指定されている場合、これはオプションのパラメータです。
ヘッダー・パラメータ
- authorization: string
clientID:secretのBase64でエンコードされたヘッダー。これは機密クライアントの認証メカニズムです。このヘッダーまたはClientAssertionTokensを通じてクライアント認証を指定できます。これらのメカニズムのいずれかを使用する必要があります。
- x-oauth-identity-domain-name: string
トークンをリクエストしているアイデンティティ・ドメイン。
フォーム・パラメータ
- assertion: string
ユーザー・アサーション・トークン。GrantTypeがJWT_BEARERの場合は必須パラメータです。
- client_assertion: string
クライアント・アサーション・トークン。クライアント・アサーション・メカニズムがClientAssertionTokenを介している場合、これは必須です。これが渡されると、認可ヘッダーは必要ありません。
- client_assertion_type: string
クライアント・アサーションのタイプ。クライアント・アサーション・メカニズムがClientAssertionTokenを介している場合、これは必須です。これが渡されると、認可ヘッダーは必要ありません。指定可能な値:
[ "JWT_BEARER", "urn:ietf:params:oauth:client-assertion-type:jwt-bearer" ]
- code: string
取得された認可コード。GrantTypeがAUTHORIZATION_CODEの場合は必須パラメータです。
- grant_type: string
アクセス・トークン・リクエストの権限タイプ指定可能な値:
[ "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE", "PASSWORD", "JWT_BEARER", "REFRESH_TOKEN" ]
- password: string
リソース所有者のパスワード。GrantTypeがPASSWORDの場合は必須パラメータです。
- redirect_uri: string
リダイレクトURI。GrantTypeがAUTHORIZATION_CODEの場合は必須パラメータです。
- refresh_token: string
新しいアクセス・トークンを生成するために再生されるリフレッシュ・トークン。GrantTypeがREFRESH_TOKENの場合は必須パラメータです。
- scope: string
アクセス・トークンでリクエストされたスコープ。REFRESH_TOKENフローでは、指定されていない場合にRefreshTokenの値がデフォルト設定されます。JWT_BEARERフロー・アクセス・トークンがUserInfoに関連するスコープをリクエストする場合、サポートされるスコープはUserInfo.me、UserInfo.email、UserInfo.profile、UserInfo.addressまたはUserInfo.phoneです。デフォルト値:
DefaultScope defined for Client
- username: string
リソース所有者のユーザー名。GrantTypeがPASSWORDの場合は必須パラメータです。
レスポンス
サポートされているメディア・タイプ
- application/json
200 レスポンス
アクセス・トークンが正常に生成されました
ルート・スキーマ: AccessToken
型:
ソースを表示
object
- access_token(optional): string
生成されたアクセス・トークン
- expires_in(optional): integer
アクセス・トークンが失効する前の時間
- refresh_token(optional): string
有効な場合、リフレッシュ・トークンが生成されます。GrantType - AUTHORIZATION_CODEおよびPASSWORDの場合のみ、これも生成されます
- token_type(optional): string
生成されたトークンのタイプ。例:- Bearer
400 レスポンス
不正なリクエスト
ルート・スキーマ: ErrorCode
型:
ソースを表示
object
- errorCode(optional): string
生成されたエラー・コード
- errorDesc(optional): string
翻訳されたエラーの説明
- secErrorDesc(optional): string
セカンダリ・エラー・メッセージ
例
次のcURLコマンドは、2者間のフローのリソース所有者資格証明を使用してアクセス・トークンを作成するサーバーに対するサンプル・リクエストを示します。
ノート:
リクエストの対象のヘッダー
-
認可: Base64 UrlでエンコードされたClientID:秘密の組合せ。
-
X-OAUTH-IDENTITY-DOMAIN-NAME: クライアントが属するアイデンティティ・ドメイン
cURLの例
curl -i -H 'Authorization: Basic U1NPTGlua0NsaWVudDp3ZWxjb21lMQ==' -H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8" -H "X-OAUTH-IDENTITY-DOMAIN-NAME: SSOLink" --request POST http://<ManagedServerHost>:<ManagedServerPort>/oauth2/rest/token -d 'grant_type=PASSWORD&username=<username>&password=<password>&scope=SSOLink.link1'
トークン作成のcURLの例
curl -i -H 'Authorization: Basic U1NPTGlua0NsaWVudDp3ZWxjb21lMQ==' -H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8" -H "X-OAUTH-IDENTITY-DOMAIN-NAME: SSOLink" --request POST http://<ManagedServerHost>:<ManagedServerPort>/oauth2/rest/token -d 'grant_type=PASSWORD&username=<username>&password=<password>&scope=SSOLink.link1'
curl -i -H 'Authorization: Basic U1NPTGlua0NsaWVudDp3ZWxjb21lMQ==' -H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8" --request POST 'http://<ManagedServerHost>:<ManagedServerPort>/oauth2/rest/token?identityDomain=SSOLink' -d 'grant_type=PASSWORD&username=<username>&password=<password>&scope=SSOLink.link1'