Jump to

• Request
• Response

Update an existing OAuth Identity Domain

put

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

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• name(required): string
  Name of the Identity Domain

Body ()

Identity Domain that needs to be modified

Root Schema : IdentityDomain

Type: object

Show Source

• consentPageURL: string
  Fully qualified URL of the customized consent page
• customAttrs: string
  Attribute of user in IDStore to store the encrypted secretkey for TOTP
• description: string
• errorPageURL: string
  Fully qualified URL of the customized error page
• identityProvider: string
  Name of the identity store against which authentication is completed
• name(required): string
  Name of the Identity Domain
• oldSecretRetentionTimeInDays: integer
  Specifies the rollover period for previous client secret to continue working. The previous client secret is assigned when a client secret is changed.
• tokenSettings: 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"
            }
        },
        "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."
        }
    }
}

Nested Schema : tokenSetting

Type: array

Show Source

• Array of: object TokenSettings

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

Nested Schema : TokenSettings

Type: object

Show Source

• lifeCycleEnabled: boolean
  Default Value: false
• refreshTokenEnabled(required): boolean
  Default Value: false
• refreshTokenExpiry(required): integer(int64)
• refreshTokenLifeCycleEnabled: boolean
  Default Value: false
• tokenExpiry(required): integer(int64)
• tokenType(required): string
  Allowed Values: [ "ACCESS_TOKEN", "AUTHZ_CODE", "SSO_LINK_TOKEN" ]

  Type of the 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Sucessfully created entity - OAuthIdentityDomain, detail

Body ()

Root Schema : IdentityDomain

Type: object

Show Source

• consentPageURL: string
  Fully qualified URL of the customized consent page
• customAttrs: string
  Attribute of user in IDStore to store the encrypted secretkey for TOTP
• description: string
• errorPageURL: string
  Fully qualified URL of the customized error page
• identityProvider: string
  Name of the identity store against which authentication is completed
• name(required): string
  Name of the Identity Domain
• oldSecretRetentionTimeInDays: integer
  Specifies the rollover period for previous client secret to continue working. The previous client secret is assigned when a client secret is changed.
• tokenSettings: 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"
            }
        },
        "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."
        }
    }
}

Nested Schema : tokenSetting

Type: array

Show Source

• Array of: object TokenSettings

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

Nested Schema : TokenSettings

Type: object

Show Source

• lifeCycleEnabled: boolean
  Default Value: false
• refreshTokenEnabled(required): boolean
  Default Value: false
• refreshTokenExpiry(required): integer(int64)
• refreshTokenLifeCycleEnabled: boolean
  Default Value: false
• tokenExpiry(required): integer(int64)
• tokenType(required): string
  Allowed Values: [ "ACCESS_TOKEN", "AUTHZ_CODE", "SSO_LINK_TOKEN" ]

  Type of the 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 Response

Failed to update OAuth entity "IdentityDomain" - name "NameofIdentityDomain"

Back to Top