Atlas
Admin — SSO

Update SSO provider

Updates an existing SSO provider. All fields are optional — only provided fields are updated. If the domain is changed, verification status is reset to 'pending', a new verification token is generated, and the provider is automatically disabled. Enabling a provider requires a verified domain.

PATCH
/api/v1/admin/sso/providers/{id}

Path Parameters

id*string
Length1 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:3001/api/v1/admin/sso/providers/prov_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{
  "provider": {
    "id": "string",
    "orgId": "string",
    "type": "saml",
    "issuer": "string",
    "domain": "string",
    "enabled": true,
    "ssoEnforced": true,
    "createdAt": "string",
    "updatedAt": "string",
    "config": {
      "property1": null,
      "property2": null
    },
    "verificationToken": "string",
    "domainVerified": true,
    "domainVerifiedAt": "string",
    "domainVerificationStatus": "pending",
    "property1": null,
    "property2": null
  }
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}