The request interface for updating a SAML Auth provider. This is used when updating a SAML provider's configuration via BaseAuth.updateProviderConfig().
Signature:
export interface SAMLUpdateAuthProviderRequest
Properties
| Property | Type | Description |
|---|---|---|
| callbackURL | string | The SAML provider's callback URL. If not provided, the existing configuration's value is not modified. |
| displayName | string | The SAML provider's updated display name. If not provided, the existing configuration's value is not modified. |
| enabled | boolean | Whether the SAML provider is enabled or not. If not provided, the existing configuration's setting is not modified. |
| idpEntityId | string | The SAML provider's updated IdP entity ID. If not provided, the existing configuration's value is not modified. |
| rpEntityId | string | The SAML provider's updated RP entity ID. If not provided, the existing configuration's value is not modified. |
| ssoURL | string | The SAML provider's updated SSO URL. If not provided, the existing configuration's value is not modified. |
| x509Certificates | string[] | The SAML provider's updated list of X.509 certificated. If not provided, the existing configuration list is not modified. |
SAMLUpdateAuthProviderRequest.callbackURL
The SAML provider's callback URL. If not provided, the existing configuration's value is not modified.
Signature:
callbackURL?: string;
SAMLUpdateAuthProviderRequest.displayName
The SAML provider's updated display name. If not provided, the existing configuration's value is not modified.
Signature:
displayName?: string;
SAMLUpdateAuthProviderRequest.enabled
Whether the SAML provider is enabled or not. If not provided, the existing configuration's setting is not modified.
Signature:
enabled?: boolean;
SAMLUpdateAuthProviderRequest.idpEntityId
The SAML provider's updated IdP entity ID. If not provided, the existing configuration's value is not modified.
Signature:
idpEntityId?: string;
SAMLUpdateAuthProviderRequest.rpEntityId
The SAML provider's updated RP entity ID. If not provided, the existing configuration's value is not modified.
Signature:
rpEntityId?: string;
SAMLUpdateAuthProviderRequest.ssoURL
The SAML provider's updated SSO URL. If not provided, the existing configuration's value is not modified.
Signature:
ssoURL?: string;
SAMLUpdateAuthProviderRequest.x509Certificates
The SAML provider's updated list of X.509 certificated. If not provided, the existing configuration list is not modified.
Signature:
x509Certificates?: string[];