Skip to main content

Update a SAML Federation credential

PATCH 
/nevisidm/api/core/v1/:clientExtId/users/:userExtId/saml-credentials/:extId

Since: 8.2511.0

Required permission(s): AccessControl.CredentialView,AccessControl.CredentialModify

Partially updates the SAML Federation credential identified by the given external ID, belonging to the specified user. Only the fields provided in the request body are updated. Omitted fields remain unchanged.

If policyExtId is provided, the referenced policy must exist and be of type SamlFederationPolicy. If omitted, the credential's existing policy association is preserved.

Request​

Path Parameters

    clientExtId stringrequired

    External ID of the client.

    Example: client-123
    userExtId stringrequired

    External ID of the user.

    Example: user-123
    extId stringrequired

    External ID of the SAML Federation credential.

    Example: saml-123

Body

required
    extId string

    New external ID for the credential. Changing the external ID is not allowed once set.

    subjectNameId string

    Updated NameID identifying the subject of the SAML assertion.

    subjectNameIdFormat string

    Updated format of the subject's NameID.

    issuerNameId string

    Updated NameID identifying the issuer of the SAML assertion (the Identity Provider).

    issuerNameIdFormat string

    Updated format of the issuer's NameID.

    policyExtId string

    External ID of the policy to associate with this credential. If omitted, the default SAML Federation policy for the client is applied.

    stateName string

    Possible values: [initial, active, tmp-locked, fail-locked, reset-code, admin-changed, disabled, archived]

    New state for the credential.

    modificationComment string

    Comment describing the reason for this modification.

Responses​

SAML Federation credential updated successfully

Schema
    created string

    Creation date of the entity.

    lastModified string

    Date when the entity was last modified.

    version int32

    Version used for optimistic locking.

    extId string

    The external ID of the credential.

    userExtId string

    The external ID of the user to whom the credential belongs.

    policyExtId string

    External ID of the associated security policy.

    stateName string

    Possible values: [initial, active, tmp-locked, fail-locked, reset-code, admin-changed, disabled, archived]

    The state of the credential. Available values: initial, active, tmp-locked, fail-locked, reset-code, admin-changed, disabled, archived.

    stateChangeReason string

    Reason for the last state change of the password.

    stateChangeDetail string

    Reason detail for the last state change of the password.

    lastSuccessfulLoginDate string

    Timestamp of last successful login.

    successfulLoginCount int32

    Counts successful logins with this credential since last initialization or reset.

    lastFailedLoginDate string

    Date of last non-technical login failure, for example, wrong password.

    failedLoginCount int32

    Counts non-technical login failures since the last successful login, initialization or reset.

    modificationComment string

    Textual comment regarding the last modification.

    type string

    Possible values: [Password, Certificate, SecurID User Mapping, Ticket Authorization, Safeword User Mapping, OTP Card, Temporary Strong Password, Generic Credential, Kerberos, mTan, Vasco, PUK, URL Ticket, DevicePassword, MobileSignature, SAML Federation, Security Questions, Context Password, OATH, FIDO UAF Authenticator, Recovery Code, FIDO2 Authenticator]

    Type of credential.

    validity object

    Describes the validity period of the password.

    from string

    Start date of the entity's validity in ISO format.

    to string

    End date of the entity's validity in ISO format.

    subjectNameId string

    Identifies the subject of the SAML assertion (generally the user to be authenticated).

    subjectNameIdFormat string

    The format of the subject's NameID. Aligns expectations between the identity provider and the service provider on how the subject is identified.

    issuerNameId string

    Identifies the issuer of the SAML assertion (the Identity Provider).

    issuerNameIdFormat string

    The format of the issuer's NameID. Aligns expectations between the identity provider and the service provider on how the issuer is identified.

    credentialValue string

    Hashed identification value with optional message digest algorithm prefix. SSHA is alias for SHA-1 and SSHA256 is alias for SHA-256 algorithms.

Loading...
Last updated on