SamlConfigurations

Update a saml configuration

Changed on

Updates the specified saml configuration by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

patch/v3/accounts/{id}/saml-configuration

Request

  • Base URL
    https://api.cryptlex.com
  • URL
    https://api.cryptlex.com/v3/accounts/{id}/saml-configuration
  • Auth
    HTTP bearer

Path parameters

idstring required

Unique identifier for the saml configuration.

Request body

metadataUrlstring uri nullable

SAML metadata xml url.

assertionConsumerServiceUrlstring uri nullable

SAML assertion consumer service url.

entityIdstring nullable

Entity Id of SAML service provider.

autoProvisionUsersboolean nullable

Auto provision users.

enabledboolean nullable

Enable or disable the SAML SSO.

defaultRolestring nullable

Default role assigned to the new users.

Response

OK

idstring uuid required
createdAtstring date-time required
updatedAtstring date-time required
metadataUrlstring required
assertionConsumerServiceUrlstring required
entityIdstring required
enabledboolean required
autoProvisionUsersboolean required
defaultRolestring nullable

Changes

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the // request property's minLength was increased from 0 to 1

    • breaking

      the // request property's minLength was increased from 0 to 1

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • breaking

      request body became required

    • breaking

      removed the media type application/*+json from the request body

    • breaking

      removed the media type text/json from the request body

    • breaking

      removed the media type text/json for the response with the status

    • warning

      deleted the header request parameter Authorization

    • info

      api operation id patch/v3/accounts/{id}/saml-configuration removed and replaced with UpdateSamlConfiguration

    • info

      the endpoint scheme security JWT was added to the API