新しいOAuthクライアントの追加
投稿
/oam/services/rest/ssa/api/v1/oauthpolicyadmin/client
リクエスト
サポートされているメディア・タイプ
- application/json
作成する必要があるOAuthクライアント
ルート・スキーマ: Client
型:
ソースを表示
object
- accessTokenCustomClaims(optional): array accessTokenCustomClaims
- attributes(optional): array attributes
- clientType(optional): string
指定可能な値:
[ "CONFIDENTIAL_CLIENT", "PUBLIC_CLIENT", "MOBILE_CLIENT" ]
クライアントのタイプ - defaultScope(optional): string
トークンで返されるデフォルトのスコープである必須スコープ
- description(optional): string
- grantTypes(optional): array grantTypes
- id(optional): string
クライアントのClientID。指定されていない場合、自動生成されます
- idDomain(optional): string
クライアントが存在するアイデンティティ・ドメインの名前
- idTokenCustomClaims(optional): array idTokenCustomClaims
- issueTLSClientCertificateBoundAccessTokens(optional): string
トークンを証明書にバインドするかどうか(true/false)
- name: string
クライアントの名前
- redirectURIs(optional): array redirectURIs
- scopes(optional): array scopes
- secret(optional): string
機密である場合のクライアントのパスワード
- tlsClientAuthSANDNS(optional): string
クライアントに対して照合される証明書SAN DNS値。
- tlsClientAuthSANEmail(optional): string
クライアントに対して照合される証明書SAN電子メール値。
- tlsClientAuthSANIP(optional): string
クライアントに対して照合される証明書SAN IP値。
- tlsClientAuthSANURI(optional): string
クライアントに対して照合される証明書SAN URI値。
- tlsClientAuthSubjectDN(optional): string
クライアントに対して照合される証明書サブジェクト値。
- tokenEndpointAuthMethod(optional): string
指定可能な値:
[ "tls_client_auth", "self_signed_tls_client_auth", "private_key_jwt", "client_secret_basic" ]
クライアントでサポートされているクライアント認証方式。"tls_client_auth"または"self_signed_tls_client_auth"が指定されている場合、"tlsClientAuthSubjectDN"、"tlsClientAuthSANDNS"、"tlsClientAuthSANURI"、"tlsClientAuthSANIP"、"tlsClientAuthSANIP"、"tlsClientAuthSANEmail"のいずれかのプロパティが必要です。 - usePKCE(optional): string
指定可能な値:
[ "NON_STRICT", "STRICT" ]
このクライアントに対してPKCEを有効にするオプション・パラメータ。指定しない場合、デフォルトはnullになります。 - userInfoCustomClaims(optional): array userInfoCustomClaims
ネストされたスキーマ: accessTokenCustomClaims
型:
ソースを表示
array
- 配列: 文字列
スコープまたは他の構成を介してリクエストされている他のクレームに加えて、アクセス・トークンに含める必要があるクレームのリストを表します
ネストされたスキーマ: grantTypes
型:
ソースを表示
array
- 配列: 文字列
指定可能な値:
[ "PASSWORD", "REFRESH_TOKEN", "JWT_BEARER", "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE" ]
ネストされたスキーマ: idTokenCustomClaims
型:
ソースを表示
array
- 配列: 文字列
スコープまたは他の構成を介してリクエストされている他のクレームに加えて、アイデンティティ・トークンに含める必要があるクレームのリストを表します
ネストされたスキーマ: userInfoCustomClaims
型:
ソースを表示
array
- 配列: 文字列
スコープまたは他の構成を介してリクエストされている他のクレームに加えて、ユーザー情報レスポンスに含める必要があるクレームのリストを表します
ネストされたスキーマ: TokenAttributeSettings
型:
object
アクセス・トークンに追加できるカスタム属性
ソースを表示
- attrName: string
カスタム属性の名前
- attrType: string
指定可能な値:
[ "STATIC", "DYNAMIC" ]
属性のタイプ - attrValue: string
カスタム属性の値。これは評価および置換される静的値または動的値になる可能性があります。
ネストされたスキーマ: RedirectURI
型:
ソースを表示
object
- isHttps(optional): boolean
デフォルト値:
true
- url: string
リダイレクトURL
レスポンス
サポートされているメディア・タイプ
- application/json
200 レスポンス
エンティティ - OAuthClient、詳細を正常に作成しました
ルート・スキーマ: Client
型:
ソースを表示
object
- accessTokenCustomClaims(optional): array accessTokenCustomClaims
- attributes(optional): array attributes
- clientType(optional): string
指定可能な値:
[ "CONFIDENTIAL_CLIENT", "PUBLIC_CLIENT", "MOBILE_CLIENT" ]
クライアントのタイプ - defaultScope(optional): string
トークンで返されるデフォルトのスコープである必須スコープ
- description(optional): string
- grantTypes(optional): array grantTypes
- id(optional): string
クライアントのClientID。指定されていない場合、自動生成されます
- idDomain(optional): string
クライアントが存在するアイデンティティ・ドメインの名前
- idTokenCustomClaims(optional): array idTokenCustomClaims
- issueTLSClientCertificateBoundAccessTokens(optional): string
トークンを証明書にバインドするかどうか(true/false)
- name: string
クライアントの名前
- redirectURIs(optional): array redirectURIs
- scopes(optional): array scopes
- secret(optional): string
機密である場合のクライアントのパスワード
- tlsClientAuthSANDNS(optional): string
クライアントに対して照合される証明書SAN DNS値。
- tlsClientAuthSANEmail(optional): string
クライアントに対して照合される証明書SAN電子メール値。
- tlsClientAuthSANIP(optional): string
クライアントに対して照合される証明書SAN IP値。
- tlsClientAuthSANURI(optional): string
クライアントに対して照合される証明書SAN URI値。
- tlsClientAuthSubjectDN(optional): string
クライアントに対して照合される証明書サブジェクト値。
- tokenEndpointAuthMethod(optional): string
指定可能な値:
[ "tls_client_auth", "self_signed_tls_client_auth", "private_key_jwt", "client_secret_basic" ]
クライアントでサポートされているクライアント認証方式。"tls_client_auth"または"self_signed_tls_client_auth"が指定されている場合、"tlsClientAuthSubjectDN"、"tlsClientAuthSANDNS"、"tlsClientAuthSANURI"、"tlsClientAuthSANIP"、"tlsClientAuthSANIP"、"tlsClientAuthSANEmail"のいずれかのプロパティが必要です。 - usePKCE(optional): string
指定可能な値:
[ "NON_STRICT", "STRICT" ]
このクライアントに対してPKCEを有効にするオプション・パラメータ。指定しない場合、デフォルトはnullになります。 - userInfoCustomClaims(optional): array userInfoCustomClaims
ネストされたスキーマ: accessTokenCustomClaims
型:
ソースを表示
array
- 配列: 文字列
スコープまたは他の構成を介してリクエストされている他のクレームに加えて、アクセス・トークンに含める必要があるクレームのリストを表します
ネストされたスキーマ: grantTypes
型:
ソースを表示
array
- 配列: 文字列
指定可能な値:
[ "PASSWORD", "REFRESH_TOKEN", "JWT_BEARER", "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE" ]
ネストされたスキーマ: idTokenCustomClaims
型:
ソースを表示
array
- 配列: 文字列
スコープまたは他の構成を介してリクエストされている他のクレームに加えて、アイデンティティ・トークンに含める必要があるクレームのリストを表します
ネストされたスキーマ: userInfoCustomClaims
型:
ソースを表示
array
- 配列: 文字列
スコープまたは他の構成を介してリクエストされている他のクレームに加えて、ユーザー情報レスポンスに含める必要があるクレームのリストを表します
ネストされたスキーマ: TokenAttributeSettings
型:
object
アクセス・トークンに追加できるカスタム属性
ソースを表示
- attrName: string
カスタム属性の名前
- attrType: string
指定可能な値:
[ "STATIC", "DYNAMIC" ]
属性のタイプ - attrValue: string
カスタム属性の値。これは評価および置換される静的値または動的値になる可能性があります。
ネストされたスキーマ: RedirectURI
型:
ソースを表示
object
- isHttps(optional): boolean
デフォルト値:
true
- url: string
リダイレクトURL
422 レスポンス
OAuthエンティティ"Client" - 名前"NameofClient"の作成に失敗しました
例
この例は、新しいクライアントを作成するサーバーに対するサンプル・リクエストを示します。
cURLの例
curl -i -H 'Content-Type: application/json' -H 'Authorization:Basic d2VibG9naWM6V2VsY29tZTE=' --request POST http:<AdminServerHost:Port>/oam/services/rest/ssa/api/v1/oauthpolicyadmin/client -d {"attributes":[{"attrName":"customeAttr1","attrValue":"CustomValue","attrType":"static"}],"secret":"welcome1","id":"TestClient","scopes":["ResServer1.scope1"],"clientType":"CONFIDENTIAL_CLIENT","idDomain":"TestDomain1", "description":"Client Description","name":"TestClient","grantTypes":["PASSWORD","CLIENT_CREDENTIALS","JWT_BEARER","REFRESH_TOKEN","AUTHORIZATION_CODE"],"defaultScope":"ResServer1.scope1","redirectURIs":[{"url":"http://localhost:8080/Sample.jsp","isHttps":true}]}
リクエスト本文の例
次の例は、JSON形式の新しいクライアントを作成するレスポンス本文のコンテンツを示します。
HTTP/1.1 200 OK Date: Thu, 27 Jul 2017 17:30:16 GMT Content-Length: 27 Content-Type: text/plain X-ORACLE-DMS-ECID: 78d30c19-07b6-4ac2-a39b-f1cbd8182ebb-0000012d X-ORACLE-DMS-RID: 0 Set-Cookie: JSESSIONID=4J2FGVVUN8MXI5vdemvJw3HFPHyraFXIDVRoRUZwc_7Uia_SOhG5!-1875566563; path=/; HttpOnly Sucessfully created entity - OAuthClient, detail...