Skip to content
Management API Reference

Updates a SSO provider by its UUID

put/v1/projects/{ref}/config/auth/sso/providers/{provider_id}

OAuth scopes

  • auth:write

The fine-grained token must include the following permissions to access this endpoint:

  • auth_config_write

Path parameters

  • ref
    Required
    string

    Project ref

  • provider_id
    Required
    string

Body

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

Response codes

  • 200
  • 401
  • 403
  • 404
  • 429

Response (200)

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