April 25, 2022

We are excited to release the new, default Auth Service API with capabilities closely aligned with the latest JSON v1.0 API spec. Please read on for details on breaking changes and legacy Auth Service API deprecation timeline.

The new Auth Service API is now the default. Users can opt out of the new Auth Service API to use the legacy API by setting the Content-Type API header to application/legacy+5-9-2022 until May 9, 2022, when the legacy Auth Service API will be deprecated.

The Auth Service API now includes pagination and expanded filtering capabilities for all endpoints, as well as a new “include” parameter for getting information about related objects. Auth Service API objects now consist of attributes and relationships, resulting in breaking changes (see below).

If you have any questions or concerns about the new Auth Service API, please complete this support ticket form and select "Account log-in/authentication" for the question "What portion of the Zus Developer Sandbox does your support ticket relate to?"

Breaking changes:

The IdentityRoleLink object is no longer available, as users can be assigned to roles directly through the POST User endpoint.
Casing changes
- Object field names are camel case (e.g., RoleID instead of role_id)
- URL terms are kebab case (e.g., app-clients instead of appclients)
Model structure changes for all object models: fields other than type or id are now modeled as attributes of the object or relationships to the object. Example:

{
  "type": "auth/users",
  "id": <UUID>,
  "attributes": {
    "email": <string>,
    "name": <string>,
    "userType": <string>
  }, 
  "relationships": {
    "role": {
      "data": { "type": "auth/roles", "id": <UUID> }
    }, 
    "practitioner": {
      "data": { "type": "fhir/practitioner", "id": <UUID> }
    }
  }
}