Type Alias PatchOIDCPayload

A patch request for an identity provider using the OIDC protocol.

type PatchOIDCPayload = {
    op: "replace" | "promote-options";
    path?:
        | "/active"
        | "/description"
        | "/meta"
        | "/options"
        | "/options/realm"
        | "/options/discoveryUrl"
        | "/options/claimsMapping"
        | "/pendingOptions"
        | "/pendingOptions/realm"
        | "/pendingOptions/discoveryUrl"
        | "/pendingOptions/clientId"
        | "/pendingOptions/clientSecret"
        | "/pendingOptions/emailVerifiedAlwaysTrue"
        | "/pendingOptions/claimsMapping"
        | "/postLogoutRedirectUri"
        | "/clockToleranceSec"
        | "/pendingOptions/idTokenSignatureAlg"
        | "/pendingOptions/decryptingKey";
    value?: unknown;
}
Index

Properties

op path? value?

Properties

op: "replace" | "promote-options"

The "operation" to be performed on a given IdP. Currently supports a custom operation value called "promote-options" that allows the test configuration to be promoted to the current configuration used for login.

path?:
    | "/active"
    | "/description"
    | "/meta"
    | "/options"
    | "/options/realm"
    | "/options/discoveryUrl"
    | "/options/claimsMapping"
    | "/pendingOptions"
    | "/pendingOptions/realm"
    | "/pendingOptions/discoveryUrl"
    | "/pendingOptions/clientId"
    | "/pendingOptions/clientSecret"
    | "/pendingOptions/emailVerifiedAlwaysTrue"
    | "/pendingOptions/claimsMapping"
    | "/postLogoutRedirectUri"
    | "/clockToleranceSec"
    | "/pendingOptions/idTokenSignatureAlg"
    | "/pendingOptions/decryptingKey"

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