ジャンプ先

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

ユーザー承認の検索

get

/oam/services/rest/consent

REST APIによって、管理者はユーザーに関連する承認をフェッチできます。APIは、指定されたユーザーに関するすべての承認、または指定されたユーザー、OAuthクライアントおよびOAuthアプリケーションの組合せに関する特定の承認を返します。

リクエスト

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

• application/x-www-form-urlencoded

問合せパラメータ

• clientIdentifier(optional): string
  OAuthクライアントID/識別子
• resServerId(optional): string
  OAuthアプリケーションID/識別子
• userId: string
  承認を取得する必要のあるユーザー名/識別子。

ヘッダー・パラメータ

• authorization: string
  Administrator:SecretのBase64でエンコードされたヘッダー。これは、weblogic管理者がリソースにアクセスするための認証メカニズムです。
• x-oauth-identity-domain-name: string
  ユーザー承認の場所として予想されるOAuthアイデンティティ・ドメイン名。

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

ユーザー承認 - 詳細を正常に取得しました

本文()

ルート・スキーマ: consent

型: array

ユーザー承認の配列

ソースを表示

• 配列: オブジェクト consent

{
    "description":"Array of user consent",
    "type":"array",
    "xml":{
        "name":"consent",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/consent"
    }
}

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

型: object

ソースを表示

• clientId: string
  OAuthクライアント識別子
• consentId: string
  OAuth承認の一意識別子
• createTimeStamp: string
  OAuth承認の作成タイムスタンプ
• resourceId: string
  OAuthアプリケーション識別子
• scopes: array scope
• valid: boolean
  OAuth承認の有効性を識別するフラグ。True - 承認は有効、False - 承認は無効

{
    "type":"object",
    "required":[
        "clientId",
        "consentId",
        "createTimeStamp",
        "resourceId",
        "scopes",
        "valid"
    ],
    "properties":{
        "clientId":{
            "type":"string",
            "description":"OAuth Client Identifier"
        },
        "consentId":{
            "type":"string",
            "description":"OAuth Consent Unique Identifier"
        },
        "createTimeStamp":{
            "type":"string",
            "description":"Creation timestamp for OAuth Consent"
        },
        "resourceId":{
            "type":"string",
            "description":"OAuth Application Identifier"
        },
        "scopes":{
            "type":"array",
            "xml":{
                "name":"scope",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/scope"
            }
        },
        "valid":{
            "type":"boolean",
            "description":"Flag to identify OAuth Consent validity. \n True - Consent is valid, \n False - Consent is In-valid"
        }
    }
}

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

型: array

ソースを表示

• 配列: 文字列
  OAuthスコープ文字列。

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

400 レスポンス

ユーザー承認 - 詳細の取得に失敗しました

本文()

ルート・スキーマ: schema

型: object

ソースを表示

• error(optional): string
  エラー・コード
• error_description(optional): string
  エラーの説明

{
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Error code"
        },
        "error_description":{
            "type":"string",
            "description":"Error description"
        }
    },
    "example":{
        "error":"400",
        "error_description":"Required parameter 'X-OAUTH-IDENTITY-DOMAIN-NAME' is not present."
    }
}

例:

{
    "error":"400",
    "error_description":"Required parameter 'X-OAUTH-IDENTITY-DOMAIN-NAME' is not present."
}

先頭に戻る

例

次の例は、OAuthアイデンティティ・ドメイン名における特定のユーザーに関するすべての承認をフェッチするサンプルのリクエストとレスポンスを示します。

すべての承認をフェッチするcURLの例

curl --location --request GET 'https://<AdminServerHost:AdminServerPort>/oam/services/rest/consent?userId=DemoUser' \
--header 'X-OAUTH-IDENTITY-DOMAIN-NAME: DemoDomain' \
--header 'Authorization: Basic d2VibG9naWM6d2VsY29tZTE=' 

サンプル・レスポンス

{
    "consents": [
        {
            "clientId": "DemoClient",
            "consentId": "ebe683b9-0345-3c35-a21d-35e57958ed21",
            "createTimeStamp": "Wed Apr 08 22:12:15 PDT 2020",
            "resourceId": "506a50c2-a892-49ee-85ad-9993169a18bf",
            "scopes": [
                "DemoResource.editDemoRes",
                "DemoResource.delDemoRes",
                "DemoResource.viewDemoRes"
            ],
            "valid": true
        },
        {
            "clientId": "DemoClient",
            "consentId": "8c1d5d3a-dc74-3939-aa72-03c12fcff3b3",
            "createTimeStamp": "Wed Apr 08 22:12:15 PDT 2020",
            "resourceId": "OPENID_MGMT_RESOURCE",
            "scopes": [
                "openid",
                "profile",
                "email"
            ],
            "valid": true
        }
    ]
}

次の例は、各ユーザーおよびクライアント・アプリケーションに関する承認をフェッチするサンプルのリクエストとレスポンスを示します。

各ユーザーおよびクライアント・アプリケーションに関する承認をフェッチするcURLコマンド

curl --location --request GET 'https://<AdminServerHost:AdminServerPort>/oam/services/rest/consent?userId=DemoUser&clientIdentifier=DemoClient&resServerId=506a50c2-a892-49ee-85ad-9993169a18bf' \
--header 'X-OAUTH-IDENTITY-DOMAIN-NAME: DemoDomain' \
--header 'Authorization: Basic d2VibG9naWM6d2VsY29tZTE='

サンプル・レスポンス

{
    "consents": [
        {
            "clientId": "DemoClient",
            "consentId": "ebe683b9-0345-3c35-a21d-35e57958ed21",
            "createTimeStamp": "Wed Apr 08 22:12:15 PDT 2020",
            "resourceId": "506a50c2-a892-49ee-85ad-9993169a18bf",
            "scopes": [
                "DemoResource.editDemoRes",
                "DemoResource.delDemoRes",
                "DemoResource.viewDemoRes"
            ],
            "valid": true
        }
    ]
}

先頭に戻る