Update SAML Config.

Request

Security

ApiKeyAuth

Bodyapplication/jsonrequired

The parameters to update the SAML config.

enabledboolean

When set, SAML settings are enabled. False by default.

Default:false

Example:true

auto_create_usersboolean

When set, the system will automatically create new Accounts for those who have logged in using SAML. This must be true if SAML user is not already registered in system. True by default.

Default:true

Example:true

metadatastring, non-empty

IdP metadata for this service provider. This is a required property for successful SAML authentication.

entity_idstring, [ 1 .. 4096 ] characters

Unique identifier of this instance as a SAML/SSO service provider.

Example:"https://dct.delphix.com"

response_skewinteger

Maximum time difference allowed between a SAML response and the DCT's current time, in seconds. If not set, it defaults to 120 seconds.

Default:120

Example:120

group_attrstring, [ 1 .. 4096 ] characters

Group mapped attribute on SAML to create account tags in DCT.

Default:"groups"

Example:"groups"

first_name_attrstring, [ 1 .. 4096 ] characters

First name attribute mapped on SAML used for mapping on DCT account.

Default:"firstName"

Example:"firstName"

last_name_attrstring, [ 1 .. 4096 ] characters

Last name attribute mapped on SAML used for mapping on DCT account.

Default:"lastName"

Example:"lastName"

curl -i -X PUT \
  https://help-api.delphix.com/_mock/data-control-tower/continuous-data/22.0.0/continuous-data-apis-dct-22.0.0/management/saml-config \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true,
    "auto_create_users": true,
    "metadata": "string",
    "entity_id": "https://dct.delphix.com",
    "response_skew": 120,
    "group_attr": "groups",
    "first_name_attr": "firstName",
    "last_name_attr": "lastName"
  }'

Responses

Bodyapplication/json

enabledboolean

When set, SAML settings are enabled. False by default.

Default:false

Example:true

auto_create_usersboolean

When set, the system will automatically create new Accounts for those who have logged in using SAML. This must be true if SAML user is not already registered in system. True by default.

Default:true

Example:true

metadatastring, non-empty

IdP metadata for this service provider. This is a required property for successful SAML authentication.

entity_idstring, [ 1 .. 4096 ] characters

Unique identifier of this instance as a SAML/SSO service provider.

Example:"https://dct.delphix.com"

response_skewinteger

Maximum time difference allowed between a SAML response and the DCT's current time, in seconds. If not set, it defaults to 120 seconds.

Default:120

Example:120

group_attrstring, [ 1 .. 4096 ] characters

Group mapped attribute on SAML to create account tags in DCT.

Default:"groups"

Example:"groups"

first_name_attrstring, [ 1 .. 4096 ] characters

First name attribute mapped on SAML used for mapping on DCT account.

Default:"firstName"

Example:"firstName"

last_name_attrstring, [ 1 .. 4096 ] characters

Last name attribute mapped on SAML used for mapping on DCT account.

Default:"lastName"

Example:"lastName"

Response

{
  "enabled": true,
  "auto_create_users": true,
  "metadata": "string",
  "entity_id": "https://dct.delphix.com",
  "response_skew": 120,
  "group_attr": "groups",
  "first_name_attr": "firstName",
  "last_name_attr": "lastName"
}