Update a saml configuration

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

JWT

account:write

Parameters

Name	Type	In	Description
id*	string	path	Unique identifier for the saml configuration.

Request Body Schema

Property	Type	Description	Constraints
metadataUrl	string	SAML metadata xml url.	min: 1, max: 2048, format: uri
assertionConsumerServiceUrl	string	SAML assertion consumer service url.	min: 1, max: 2048, format: uri
entityId	string	Entity Id of SAML service provider.	min: 1, max: 256
autoProvisionUsers	boolean	Auto provision users.
enabled	boolean	Enable or disable the SAML SSO.
defaultRole	string	Default role assigned to the new users.	min: 1, max: 256
samlRoleMappings	array	Role mapping.	items: object
identityProviderRole*	string	Identity provider role.	min: 1, max: 256
serviceProviderRole*	string	Service provider role.	min: 1, max: 256
attributeMapping	object
email	array	SAML attribute name to map to the User email.	items: string
firstName	array	SAML attribute name to map to the User first name.	items: string
lastName	array	SAML attribute name to map to the User last name.	items: string
role	array	SAML attribute name to map to the User role.	items: string

Request Example

{
  "metadataUrl": "http://example.com",
  "assertionConsumerServiceUrl": "http://example.com",
  "entityId": "string",
  "autoProvisionUsers": true,
  "enabled": true,
  "defaultRole": "string",
  "samlRoleMappings": [
    {
      "identityProviderRole": "string",
      "serviceProviderRole": "string"
    }
  ],
  "attributeMapping": {
    "email": [
      "string"
    ],
    "firstName": [
      "string"
    ],
    "lastName": [
      "string"
    ],
    "role": [
      "string"
    ]
  }
}

Triggers webhook: samlConfiguration.updated

POST <your-webhook-url>
{
  "event": "samlConfiguration.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "metadataUrl": "string",
    "assertionConsumerServiceUrl": "string",
    "entityId": "string",
    "enabled": true,
    "autoProvisionUsers": true,
    "defaultRole": "string",
    "samlRoleMappings": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "serviceProviderRole": "string",
        "identityProviderRole": "string"
      }
    ],
    "attributeMapping": {
      "email": [
        "string"
      ],
      "firstName": [
        "string"
      ],
      "lastName": [
        "string"
      ],
      "role": [
        "string"
      ]
    }
  },
  "triggeredAt": "string"
}

Responses

200

400

401

403

404

429

500

200 OK

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "metadataUrl": "string",
  "assertionConsumerServiceUrl": "string",
  "entityId": "string",
  "enabled": true,
  "autoProvisionUsers": true,
  "defaultRole": "string",
  "samlRoleMappings": [
    {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "serviceProviderRole": "string",
      "identityProviderRole": "string"
    }
  ],
  "attributeMapping": {
    "email": [
      "string"
    ],
    "firstName": [
      "string"
    ],
    "lastName": [
      "string"
    ],
    "role": [
      "string"
    ]
  }
}