ジャンプ先

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

既存のOAuthアイデンティティ・ドメインの更新

put

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

リクエスト

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

• application/json
• application/xml

問合せパラメータ

• name: string
  アイデンティティ・ドメインの名前

本文()

変更する必要があるアイデンティティ・ドメイン

ルート・スキーマ: IdentityDomain

型: object

ソースを表示

• consentPageURL(optional): string
  カスタマイズされた同意ページの完全修飾URL
• customAttrs(optional): string
  TOTPの暗号化された秘密キーを格納するためのIDStoreのユーザーの属性
• description(optional): string
• errorPageURL(optional): string
  カスタマイズされたエラー・ページの完全修飾URL
• identityProvider(optional): string
  認証を完了しているアイデンティティ・ストアの名前
• name: string
  アイデンティティ・ドメインの名前
• tokenSettings(optional): array tokenSetting

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Identity Domain"
        },
        "consentPageURL":{
            "type":"string",
            "description":"Fully qualified URL of the customized consent page"
        },
        "errorPageURL":{
            "type":"string",
            "description":"Fully qualified URL of the customized error page"
        },
        "identityProvider":{
            "type":"string",
            "description":"Name of the identity store against which authentication is completed"
        },
        "description":{
            "type":"string"
        },
        "customAttrs":{
            "type":"string",
            "description":"Attribute of user in IDStore to store the encrypted secretkey for TOTP"
        },
        "tokenSettings":{
            "type":"array",
            "xml":{
                "name":"tokenSetting",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/TokenSettings"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト TokenSettings

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

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

型: object

ソースを表示

• lifeCycleEnabled(optional): boolean
  デフォルト値: false
• refreshTokenEnabled: boolean
  デフォルト値: false
• refreshTokenExpiry: integer(int64)
• refreshTokenLifeCycleEnabled(optional): boolean
  デフォルト値: false
• tokenExpiry: integer(int64)
• tokenType: string
  指定可能な値: [ "ACCESS_TOKEN", "AUTHZ_CODE", "SSO_LINK_TOKEN" ]

  トークンのタイプ

{
    "type":"object",
    "required":[
        "refreshTokenEnabled",
        "refreshTokenExpiry",
        "tokenType",
        "tokenExpiry"
    ],
    "properties":{
        "refreshTokenEnabled":{
            "type":"boolean",
            "default":false
        },
        "refreshTokenLifeCycleEnabled":{
            "type":"boolean",
            "default":false
        },
        "refreshTokenExpiry":{
            "type":"integer",
            "format":"int64"
        },
        "lifeCycleEnabled":{
            "type":"boolean",
            "default":false
        },
        "tokenType":{
            "type":"string",
            "description":"Type of the token",
            "enum":[
                "ACCESS_TOKEN",
                "AUTHZ_CODE",
                "SSO_LINK_TOKEN"
            ]
        },
        "tokenExpiry":{
            "type":"integer",
            "format":"int64"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

エンティティ - OAuthIdentityDomain、詳細を正常に作成しました

本文()

ルート・スキーマ: IdentityDomain

型: object

ソースを表示

• consentPageURL(optional): string
  カスタマイズされた同意ページの完全修飾URL
• customAttrs(optional): string
  TOTPの暗号化された秘密キーを格納するためのIDStoreのユーザーの属性
• description(optional): string
• errorPageURL(optional): string
  カスタマイズされたエラー・ページの完全修飾URL
• identityProvider(optional): string
  認証を完了しているアイデンティティ・ストアの名前
• name: string
  アイデンティティ・ドメインの名前
• tokenSettings(optional): array tokenSetting

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Identity Domain"
        },
        "consentPageURL":{
            "type":"string",
            "description":"Fully qualified URL of the customized consent page"
        },
        "errorPageURL":{
            "type":"string",
            "description":"Fully qualified URL of the customized error page"
        },
        "identityProvider":{
            "type":"string",
            "description":"Name of the identity store against which authentication is completed"
        },
        "description":{
            "type":"string"
        },
        "customAttrs":{
            "type":"string",
            "description":"Attribute of user in IDStore to store the encrypted secretkey for TOTP"
        },
        "tokenSettings":{
            "type":"array",
            "xml":{
                "name":"tokenSetting",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/TokenSettings"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト TokenSettings

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

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

型: object

ソースを表示

• lifeCycleEnabled(optional): boolean
  デフォルト値: false
• refreshTokenEnabled: boolean
  デフォルト値: false
• refreshTokenExpiry: integer(int64)
• refreshTokenLifeCycleEnabled(optional): boolean
  デフォルト値: false
• tokenExpiry: integer(int64)
• tokenType: string
  指定可能な値: [ "ACCESS_TOKEN", "AUTHZ_CODE", "SSO_LINK_TOKEN" ]

  トークンのタイプ

{
    "type":"object",
    "required":[
        "refreshTokenEnabled",
        "refreshTokenExpiry",
        "tokenType",
        "tokenExpiry"
    ],
    "properties":{
        "refreshTokenEnabled":{
            "type":"boolean",
            "default":false
        },
        "refreshTokenLifeCycleEnabled":{
            "type":"boolean",
            "default":false
        },
        "refreshTokenExpiry":{
            "type":"integer",
            "format":"int64"
        },
        "lifeCycleEnabled":{
            "type":"boolean",
            "default":false
        },
        "tokenType":{
            "type":"string",
            "description":"Type of the token",
            "enum":[
                "ACCESS_TOKEN",
                "AUTHZ_CODE",
                "SSO_LINK_TOKEN"
            ]
        },
        "tokenExpiry":{
            "type":"integer",
            "format":"int64"
        }
    }
}

422 レスポンス

OAuthエンティティ"IdentityDomain" - 名前"NameofIdentityDomain"の更新に失敗しました

先頭に戻る