Jump to

• Request
• Response

Delete a Trust Artifact under an IdentityDomain based on the Artifact Identifier

delete

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

Request

Supported Media Types

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

Query Parameters

• artifactIdentfier: string
  ArtifactIdentifier
• identityDomainName: string
  Name of the Identity Domain under which the Trust Artifact exists

Back to Top

Response

Supported Media Types

• application/json

200 Response

Sucessfully deleted entity - "OAuthIdentityDomainTrustArtifact", detail

Body ()

Root Schema : IdentityDomainResponse

Type: object

Show Source

• consentPageURL(optional): string
  Fully qualified URL of the customized consent page
• description(optional): string
• errorPageURL(optional): string
  Fully qualified URL of the customized error page
• identityProvider(optional): string
  Name of the identity store against which authentication is completed
• name: string
  Name of the Identity Domain
• tokenSettings(optional): array tokenSetting
• trustStoreIdentifier(optional): array trustStoreIdentifier

{
    "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"
        },
        "trustStoreIdentifier":{
            "type":"array",
            "xml":{
                "name":"trustStoreIdentifier",
                "wrapped":true
            },
            "items":{
                "type":"string"
            }
        },
        "tokenSettings":{
            "type":"array",
            "xml":{
                "name":"tokenSetting",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/TokenSettings"
            }
        }
    }
}

Nested Schema : tokenSetting

Type: array

Show Source

• Array of: object TokenSettings

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

Nested Schema : trustStoreIdentifier

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "xml":{
        "name":"trustStoreIdentifier",
        "wrapped":true
    },
    "items":{
        "type":"string"
    }
}

Nested Schema : TokenSettings

Type: object

Show Source

• lifeCycleEnabled(optional): boolean
  Default Value: false
• refreshTokenEnabled: boolean
  Default Value: false
• refreshTokenExpiry: integer(int64)
• refreshTokenLifeCycleEnabled(optional): boolean
  Default Value: false
• tokenExpiry: integer(int64)
• tokenType: 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 modify OAuth entity "IdentityDomain" - name "NameofIdentityDomain"

Back to Top