GET
/
v1
/
tenants
/
{id}
/
sso-settings
Get SSO settings
curl --request GET \
  --url https://staging.api.us.aptlydone.com/auth/v1/tenants/{id}/sso-settings \
  --header 'Authorization: Bearer <token>'
{
  "statusCode": 200,
  "timestamp": "2025-06-25T06:16:48.664Z",
  "message": "Success",
  "data": {
    "saml": {
      "attributeMapping": {
        "name": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name",
        "email": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress",
        "username": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/username",
        "phoneNumber": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/phonenum",
        "givenName": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname",
        "middleName": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/middlename",
        "familyName": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname",
        "picture": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/picture",
        "verifiedEmail": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/verifiedemail",
        "verifiedPhone": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/verifiedphone",
        "group": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/groups",
        "customAttributes": {
          "department": "Industrial",
          "jobTitle": "Human Infrastructure Analyst",
          "location": "Wilmington"
        }
      }
    },
    "oidc": {
      "attributeMapping": {
        "loginId": "preferred_username",
        "name": "name",
        "email": "email",
        "username": "username",
        "phoneNumber": "phone_number",
        "givenName": "given_name",
        "middleName": "middle_name",
        "familyName": "family_name",
        "picture": "picture",
        "verifiedEmail": "email_verified",
        "verifiedPhone": "phone_number_verified",
        "customAttributes": {
          "department": "Toys",
          "jobTitle": "National Functionality Coordinator",
          "location": "Lebsackport"
        }
      }
    },
    "ssoId": "sso-provider-995ef87a-a459-4cb1-89d4-685729370869"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200 - application/json

SSO settings fetched successfully

The response is of type object.