Type Alias PatchSAMLPayload

A patch request for an identity provider using the SAML protocol. Supports a custom operation value called promote-options that allows the test configuration (pendingOptions) to be promoted to the live configuration (options) used for login.'

type PatchSAMLPayload = {
    op: "replace" | "promote-options";
    path?:
        | "/active"
        | "/description"
        | "/pendingOptions"
        | "/pendingOptions/nameIdFormat"
        | "/pendingOptions/allowIdpInitiatedLogin"
        | "/pendingOptions/entityId"
        | "/pendingOptions/signOnUrl"
        | "/pendingOptions/metadata"
        | "/pendingOptions/certificates"
        | "/pendingOptions/claimsMapping"
        | "/postLogoutRedirectUri"
        | "/clockToleranceSec";
    value?: unknown;
}
Index

Properties

op path? value?

Properties

op: "replace" | "promote-options"

The "operation" to be performed on a given IdP.

path?:
    | "/active"
    | "/description"
    | "/pendingOptions"
    | "/pendingOptions/nameIdFormat"
    | "/pendingOptions/allowIdpInitiatedLogin"
    | "/pendingOptions/entityId"
    | "/pendingOptions/signOnUrl"
    | "/pendingOptions/metadata"
    | "/pendingOptions/certificates"
    | "/pendingOptions/claimsMapping"
    | "/postLogoutRedirectUri"
    | "/clockToleranceSec"

The "path" to the part of the IdP document.

value?: unknown

The "value" data type is dependent on the path value being used.

Settings

Member Visibility

On This Page

Properties