Sign in
orgs

Update Sso Settings

Update SSO provider settings defaults for the current organization.

patch/api/v1/orgs/current/sso-settings/{id}

Path parameters

idstring uuid required

Request body

default_workspace_role_idstring uuid nullable
default_workspace_idsstring[] nullable
metadata_urlstring nullable
metadata_xmlstring nullable
sso_groups_enabledboolean nullable
sso_groups_claim_fieldstring nullable
sso_groups_requiredboolean nullable
sso_groups_role_sync_enabledboolean nullable

Response

Successful Response

idstring uuid required
organization_idstring uuid required
provider_idstring uuid required
default_workspace_role_idstring uuid required
default_workspace_idsstring[] required
metadata_urlstring nullable
metadata_xmlstring nullable
sso_groups_enabledboolean
sso_groups_claim_fieldstring
sso_groups_requiredboolean
sso_groups_role_sync_enabledboolean
attribute_mapping_load_errorstring nullable

Changes

Changed in 1 of the 48 revisions of this API.11

  • 99490d1e837e11See the full diff
    • ○

      added the new optional request property attribute_mapping

      new-optional-request-property

    • ○

      added the new optional request property sso_groups_claim_field

      new-optional-request-property

    • ○

      added the new optional request property sso_groups_enabled

      new-optional-request-property

    • ○

      added the new optional request property sso_groups_required

      new-optional-request-property

    • ○

      added the new optional request property sso_groups_role_sync_enabled

      new-optional-request-property

    • ○

      added the optional property attribute_mapping to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property attribute_mapping_load_error to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property sso_groups_claim_field to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property sso_groups_enabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property sso_groups_required to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property sso_groups_role_sync_enabled to the response with the 200 status

      response-optional-property-added

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog