ジャンプ先

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

ユーザー承認の削除

delete

/oauth2/rest/consent

REST APIによって、エンド・ユーザーはユーザーに関連する承認を削除できます。複数の承認識別子を指定して、複数の承認を同時に削除できます。

リクエスト

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

• application/x-www-form-urlencoded

問合せパラメータ

• cid: string
  取り消す必要のある一意の承認識別子。このパラメータの値は、GET承認レスポンスからフェッチできます。
• identityDomain(optional): string
  トークンをリクエストしているアイデンティティ・ドメイン。'x-oauth-identity-domain-name'ヘッダー・パラメータが指定されている場合、これはオプションのパラメータです。

ヘッダー・パラメータ

• oam_remote_user: string
  承認を取得する必要のあるユーザー名/識別子。
• 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 'userId' is not present."
    }
}

例:

{
    "error":"400",
    "error_description":"Required parameter 'userId' is not present."
}

先頭に戻る

例

次の例は、承認を削除するサンプルのリクエストとレスポンスを示します。

承認を削除するcURLコマンド

curl --location --request DELETE 'http://<lbr-host>:<lbr-port>/oauth2/rest/consent?cid=ebe683b9-0345-3c35-a21d-35e57958ed21&cid=8c1d5d3a-dc74-3939-aa72-03c12fcff3b3' \
--header 'X-OAUTH-IDENTITY-DOMAIN-NAME: DemoDomain' \
--header 'OAM_REMOTE_USER: DemoUser'

サンプル・レスポンス

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

先頭に戻る