ジャンプ先

• リクエスト
• レスポンス

名前別またはID別のOAuthクライアントの検索

get

/oam/services/rest/ssa/api/v1/oauthpolicyadmin/client

OAuthクライアントを返します。クライアントの名前またはIDを使用して、検索を実行できます。1つの問合せパラメータのみ指定する必要があります。

リクエスト

サポートされているメディア・タイプ

• application/json
• application/x-www-form-urlencoded

問合せパラメータ

• id(required): string
  クライアントのClientID
• identityDomainName(required): string
  クライアントが存在するアイデンティティ・ドメインの名前
• name(required): string
  クライアントの名前

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200 レスポンス

エンティティ - OAuthClient、詳細を正常に取得しました

本文()

ルート・スキーマ: Client

型: object

ソースを表示

• accessTokenCustomClaims: array accessTokenCustomClaims
• attributes: array attributes
• clientType: string
  指定可能な値: [ "CONFIDENTIAL_CLIENT", "PUBLIC_CLIENT", "MOBILE_CLIENT" ]

  クライアントのタイプ
• defaultScope: string
  トークンで返されるデフォルトのスコープである必須スコープ
• description: string
• grantTypes: array grantTypes
• id: string
  クライアントのClientID。指定されていない場合、自動生成されます
• idDomain: string
  クライアントが存在するアイデンティティ・ドメインの名前
• idTokenCustomClaims: array idTokenCustomClaims
• issueTLSClientCertificateBoundAccessTokens: string
  トークンを証明書にバインドするかどうか(true/false)
• name(required): string
  クライアントの名前
• oldSecretRetentionTimeInDays: integer
  前のクライアント・シークレットの作業を続行するためのロールオーバー期間を指定します。前のクライアント・シークレットは、クライアント・シークレットが変更されると割り当てられます。
• redirectURIs: array redirectURIs
• scopes: array scopes
• secret: string
  機密である場合のクライアントのパスワード
• tlsClientAuthSANDNS: string
  クライアントに対して照合される証明書SAN DNS値。
• tlsClientAuthSANEmail: string
  クライアントに対して照合される証明書SAN電子メール値。
• tlsClientAuthSANIP: string
  クライアントに対して照合される証明書SAN IP値。
• tlsClientAuthSANURI: string
  クライアントに対して照合される証明書SAN URI値。
• tlsClientAuthSubjectDN: string
  クライアントに対して照合される証明書サブジェクト値。
• tokenEndpointAuthMethod: 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: string
  指定可能な値: [ "NON_STRICT", "STRICT" ]

  このクライアントに対してPKCEを有効にするオプション・パラメータ。指定しない場合、デフォルトはnullになります。
• userInfoCustomClaims: array userInfoCustomClaims

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Client"
        },
        "description":{
            "type":"string"
        },
        "idDomain":{
            "type":"string",
            "description":"Name of the Identity Domain under which the Client exists"
        },
        "id":{
            "type":"string",
            "description":"ClientID for the client. Will be auto generated if not specified"
        },
        "secret":{
            "type":"string",
            "description":"Password for the client if confidential"
        },
        "clientType":{
            "type":"string",
            "description":"Type of the client",
            "enum":[
                "CONFIDENTIAL_CLIENT",
                "PUBLIC_CLIENT",
                "MOBILE_CLIENT"
            ]
        },
        "grantTypes":{
            "type":"array",
            "xml":{
                "name":"grantTypes",
                "wrapped":true
            },
            "items":{
                "type":"string",
                "enum":[
                    "PASSWORD",
                    "REFRESH_TOKEN",
                    "JWT_BEARER",
                    "CLIENT_CREDENTIALS",
                    "AUTHORIZATION_CODE"
                ]
            }
        },
        "scopes":{
            "type":"array",
            "xml":{
                "name":"scopes",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/ScopeSettings"
            }
        },
        "usePKCE":{
            "type":"string",
            "description":"Optional parameter to enable PKCE for this client. If not specified, default will be null.",
            "enum":[
                "NON_STRICT",
                "STRICT"
            ]
        },
        "defaultScope":{
            "type":"string",
            "description":"Mandatory scope which is the default scope returned in the token"
        },
        "redirectURIs":{
            "type":"array",
            "xml":{
                "name":"redirectURIs",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RedirectURI"
            }
        },
        "attributes":{
            "type":"array",
            "xml":{
                "name":"attributes",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/TokenAttributeSettings"
            }
        },
        "tokenEndpointAuthMethod":{
            "type":"string",
            "description":"Client Authentication method supported by the client. If \"tls_client_auth\" or  \"self_signed_tls_client_auth\" is specified then one of the \"tlsClientAuthSubjectDN\",\"tlsClientAuthSANDNS\",\"tlsClientAuthSANURI\",\"tlsClientAuthSANIP\",\"tlsClientAuthSANIP\",\"tlsClientAuthSANEmail\" property is required.",
            "enum":[
                "tls_client_auth",
                "self_signed_tls_client_auth",
                "private_key_jwt",
                "client_secret_basic"
            ]
        },
        "issueTLSClientCertificateBoundAccessTokens":{
            "type":"string",
            "description":"Tokens should be bound to certificate or not true/false"
        },
        "tlsClientAuthSubjectDN":{
            "type":"string",
            "description":"Certificate subject value to be matched  for the client."
        },
        "tlsClientAuthSANDNS":{
            "type":"string",
            "description":"Certificate SAN DNS value to be matched  for the client."
        },
        "tlsClientAuthSANURI":{
            "type":"string",
            "description":"Certificate SAN URI value to be matched  for the client."
        },
        "tlsClientAuthSANIP":{
            "type":"string",
            "description":"Certificate SAN IP value to be matched  for the client."
        },
        "tlsClientAuthSANEmail":{
            "type":"string",
            "description":"Certificate SAN email value to be matched  for the client."
        },
        "accessTokenCustomClaims":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Represents a list of claims that must be included in the Access Token in addition to other claims that are being requested via scope or other configurations"
            }
        },
        "idTokenCustomClaims":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Represents a list of claims that must be included in the Identity Token in addition to other claims that are being requested via scope or other configurations"
            }
        },
        "userInfoCustomClaims":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Represents a list of claims that must be included in the User Info response in addition to other claims that are being requested via scope or other configurations"
            }
        },
        "oldSecretRetentionTimeInDays":{
            "type":"integer",
            "description":"Specifies the rollover period for previous client secret to continue working. The previous client secret is assigned when a client secret is changed."
        }
    }
}

ネストされたスキーマ: accessTokenCustomClaims

型: array

ソースを表示

• 配列: 文字列
  スコープまたは他の構成を介してリクエストされている他のクレームに加えて、アクセス・トークンに含める必要があるクレームのリストを表します

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Represents a list of claims that must be included in the Access Token in addition to other claims that are being requested via scope or other configurations"
    }
}

ネストされたスキーマ: attributes

型: array

ソースを表示

• 配列: オブジェクト TokenAttributeSettings
  アクセス・トークンに追加できるカスタム属性

{
    "type":"array",
    "xml":{
        "name":"attributes",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/TokenAttributeSettings"
    }
}

ネストされたスキーマ: grantTypes

型: array

ソースを表示

• 配列: 文字列
  指定可能な値: [ "PASSWORD", "REFRESH_TOKEN", "JWT_BEARER", "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE" ]

{
    "type":"array",
    "xml":{
        "name":"grantTypes",
        "wrapped":true
    },
    "items":{
        "type":"string",
        "enum":[
            "PASSWORD",
            "REFRESH_TOKEN",
            "JWT_BEARER",
            "CLIENT_CREDENTIALS",
            "AUTHORIZATION_CODE"
        ]
    }
}

ネストされたスキーマ: idTokenCustomClaims

型: array

ソースを表示

• 配列: 文字列
  スコープまたは他の構成を介してリクエストされている他のクレームに加えて、アイデンティティ・トークンに含める必要があるクレームのリストを表します

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Represents a list of claims that must be included in the Identity Token in addition to other claims that are being requested via scope or other configurations"
    }
}

ネストされたスキーマ: redirectURIs

型: array

ソースを表示

• 配列: オブジェクト RedirectURI

{
    "type":"array",
    "xml":{
        "name":"redirectURIs",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/RedirectURI"
    }
}

ネストされたスキーマ: scopes

型: array

ソースを表示

• 配列: オブジェクト ScopeSettings

{
    "type":"array",
    "xml":{
        "name":"scopes",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/ScopeSettings"
    }
}

ネストされたスキーマ: userInfoCustomClaims

型: array

ソースを表示

• 配列: 文字列
  スコープまたは他の構成を介してリクエストされている他のクレームに加えて、ユーザー情報レスポンスに含める必要があるクレームのリストを表します

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Represents a list of claims that must be included in the User Info response in addition to other claims that are being requested via scope or other configurations"
    }
}

ネストされたスキーマ: TokenAttributeSettings

型: object

アクセス・トークンに追加できるカスタム属性

ソースを表示

• attrName(required): string
  カスタム属性の名前
• attrType(required): string
  指定可能な値: [ "STATIC", "DYNAMIC" ]

  属性のタイプ
• attrValue(required): string
  カスタム属性の値。これは評価および置換される静的値または動的値になる可能性があります。

{
    "type":"object",
    "description":"Custom attributes that can be added to the Access Token",
    "required":[
        "attrName",
        "attrValue",
        "attrType"
    ],
    "properties":{
        "attrName":{
            "type":"string",
            "description":"Name of the custom attribute"
        },
        "attrValue":{
            "type":"string",
            "description":"Value of the custom attribute. This could be a static value or a dynamic one that is evaluated and substituted."
        },
        "attrType":{
            "type":"string",
            "description":"Type of the Attribute",
            "enum":[
                "STATIC",
                "DYNAMIC"
            ]
        }
    }
}

ネストされたスキーマ: RedirectURI

型: object

ソースを表示

• isHttps: boolean
  デフォルト値: true
• url(required): string
  リダイレクトURL

{
    "type":"object",
    "required":[
        "url"
    ],
    "properties":{
        "url":{
            "type":"string",
            "description":"Redirect URL"
        },
        "isHttps":{
            "type":"boolean",
            "default":"true"
        }
    }
}

ネストされたスキーマ: ScopeSettings

型: object

ソースを表示

• scopeName(required): string
  スコープの名前

{
    "type":"object",
    "required":[
        "scopeName"
    ],
    "properties":{
        "scopeName":{
            "type":"string",
            "description":"Name of the scope"
        }
    }
}

422 レスポンス

OAuthエンティティ"Client" - 名前"NameofClient"の取得に失敗しました

先頭に戻る