Delete a sso provider | Management API Reference

Removes a SSO provider by its UUID

delete/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

Response codes

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
          "array": true,
15
          "default": {}
16
        },
17
        "property2": {
18
          "name": "lorem",
19
          "names": [
20
            "lorem"
21
          ],
22
          "array": true,
23
          "default": {}
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
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "id": {
5
      "type": "string"
6
    },
7
    "saml": {
8
      "type": "object",
9
      "properties": {
10
        "entity_id": {
11
          "type": "string"
12
        },
13
        "metadata_url": {
14
          "type": "string"
15
        },
16
        "metadata_xml": {
17
          "type": "string"
18
        },
19
        "attribute_mapping": {
20
          "type": "object",
21
          "properties": {
22
            "keys": {
23
              "type": "object",
24
              "additionalProperties": {
25
                "type": "object",
26
                "properties": {
27
                  "name": {
28
                    "type": "string"
29
                  },
30
                  "names": {
31
                    "type": "array",
32
                    "items": {
33
                      "type": "string"
34
                    }
35
                  },
36
                  "array": {
37
                    "type": "boolean"
38
                  },
39
                  "default": {
40
                    "anyOf": [
41
                      {
42
                        "type": "object",
43
                        "properties": {}
44
                      },
45
                      {
46
                        "type": "number"
47
                      },
48
                      {
49
                        "type": "string"
50
                      },
51
                      {
52
                        "type": "boolean"
53
                      }
54
                    ]
55
                  }
56
                }
57
              }
58
            }
59
          },
60
          "required": [
61
            "keys"
62
          ]
63
        },
64
        "name_id_format": {
65
          "type": "string",
66
          "enum": [
67
            "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified",
68
            "urn:oasis:names:tc:SAML:2.0:nameid-format:transient",
69
            "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress",
70
            "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"
71
          ]
72
        }
73
      },
74
      "required": [
75
        "entity_id"
76
      ]
77
    },
78
    "domains": {
79
      "type": "array",
80
      "items": {
81
        "type": "object",
82
        "properties": {
83
          "domain": {
84
            "type": "string"
85
          },
86
          "created_at": {
87
            "type": "string"
88
          },
89
          "updated_at": {
90
            "type": "string"
91
          }
92
        }
93
      }
94
    },
95
    "created_at": {
96
      "type": "string"
97
    },
98
    "updated_at": {
99
      "type": "string"
100
    }
101
  },
102
  "required": [
103
    "id"
104
  ]
105
}