v1

latestOpenAPI 3.0.02026-07-14169146300.3 KB
Auth

Creates a new SSO provider

post/v1/projects/{ref}/config/auth/sso/providers

Path parameters

refstring required
Example:abcdefghijklmnopqrst

Project ref

Request body

type'saml' required

What type of provider will be created

metadata_xmlstring
metadata_urlstring
domainsstring[]
name_id_format'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified' | 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient' | 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress' | 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent'

Example request

{
  "type": "saml",
  "metadata_url": "https://sso.acme.com/metadata.xml",
  "domains": [
    "acme.com"
  ],
  "attribute_mapping": {
    "keys": {
      "email": {
        "name": "email"
      },
      "first_name": {
        "name": "first_name"
      },
      "last_name": {
        "name": "last_name"
      }
    }
  }
}

Response

idstring required
created_atstring
updated_atstring