Skip to content
Management API Reference

Creates a new SSO provider

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

OAuth scopes

  • auth:write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • type
    Required
    enum
  • metadata_xml
    Optional
    string
  • metadata_url
    Optional
    string
  • domains
    Optional
    Array<string>
  • attribute_mapping
    Optional
    object
  • name_id_format
    Optional
    enum

Response codes

  • 201
  • 401
  • 403
  • 404
  • 429

Response (201)

1
{
2
  "id": "lorem",
3
  "saml": {
4
    "id": "lorem",
5
    "entity_id": "lorem",
6
    "metadata_url": "lorem",
7
    "metadata_xml": "lorem",
8
    "attribute_mapping": {
9
      "keys": {
10
        "property1": {
11
          "name": "lorem",
12
          "names": [
13
            "lorem"
14
          ],
15
          "default": {},
16
          "array": true
17
        },
18
        "property2": {
19
          "name": "lorem",
20
          "names": [
21
            "lorem"
22
          ],
23
          "default": {},
24
          "array": true
25
        }
26
      }
27
    },
28
    "name_id_format": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified"
29
  },
30
  "domains": [
31
    {
32
      "id": "lorem",
33
      "domain": "lorem",
34
      "created_at": "lorem",
35
      "updated_at": "lorem"
36
    }
37
  ],
38
  "created_at": "lorem",
39
  "updated_at": "lorem"
40
}