Skip to main content
PATCH
/
api
/
v1
/
orgs
/
current
/
sso-settings
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_workspace_role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_workspace_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "metadata_url": "<string>",
  "metadata_xml": "<string>",
  "sso_groups_enabled": false,
  "sso_groups_claim_field": "groups",
  "sso_groups_required": false,
  "sso_groups_role_sync_enabled": true,
  "attribute_mapping": {
    "keys": {}
  },
  "attribute_mapping_load_error": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
default_workspace_role_id
string<uuid> | null
​
default_workspace_ids
string<uuid>[] | null
​
metadata_url
string | null
​
metadata_xml
string | null
​
sso_groups_enabled
boolean | null
​
sso_groups_claim_field
string | null
​
sso_groups_required
boolean | null
​
sso_groups_role_sync_enabled
boolean | null
​
attribute_mapping
SupabaseAttributeMapping · object

Supabase SAML provider attribute_mapping. Empty keys is a valid value (clears the mapping). Map key is the claim key written into identity_data; value points at the SAML assertion attribute name.

Response

Successful Response

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
provider_id
string<uuid>
required
​
default_workspace_role_id
string<uuid>
required
​
default_workspace_ids
string<uuid>[]
required
​
metadata_url
string | null
​
metadata_xml
string | null
​
sso_groups_enabled
boolean
default:false
​
sso_groups_claim_field
string
default:groups
​
sso_groups_required
boolean
default:false
​
sso_groups_role_sync_enabled
boolean
default:true
​
attribute_mapping
SupabaseAttributeMapping · object

Supabase SAML provider attribute_mapping. Empty keys is a valid value (clears the mapping). Map key is the claim key written into identity_data; value points at the SAML assertion attribute name.

​
attribute_mapping_load_error
string | null