Skip to content

Directory

Directory Module API - v4.3.0

Breaking Changes

  • Standardized the schema for responses that result in a 400 status code. Changed from BadRequestResponse to ValidationProblemDetails

Addtions and Enhancements

  • Added support to retrieve meta information for Weather Subscriptions and the packaging configured for a specific TenantId.
  • Extended the UserProfile to include additional details about the user. These additions are more typically used for internal user use casees. The additional pieces of information relate to:
    • Organization
      • Includes JobTitle and Department
    • Authorization
      • Includes the Role the UserProfile may be assigned to.
    • LegacyAuthorization
      • Includes a collection of groups they're authorized to access

Directory Module API - v4.2.3

Additions and Enhancements

  • Added support for Weather Categories and Weather preferences
  • Added support for Querying for Users by Phone Number

Bug Fixes

  • Resolved an issue that occurred when creating a new User Location where the API was returning an incorrect response code (200 OK) according to the API Specification (201 Created).
  • Resolved issue with Location IDs not being deterministic

Directory Module API - v4.2.0

Additions and Enhancements

  • Added support for creating users with ExternalId and looking up users by their ExternalId
  • Updated most 400 level error responses with clearer error messages.

Bug Fixes

  • Resolved an issue with Written and Spoken language preferences not being persisted

Breaking Changes:

  • Updated CreatePhoneCommand to return the PhoneNumber created in the response
  • Removed Default property on GroupSummary into a separate objected called SelfServiceSettings that has a Default property and will be used for future expansion.

Directory Module API - v4.1.0

Additions and Enhancements

  • The Platform API is now fully connected to the Tenant associated with the Identity that is authenticated through Client Credentials.

Bug Fixes

  • No bug fixes

Breaking Changes:

  • Changed the Meta Language and Timezone APIs to return the settings for the TenantId specified instead of by Realm.
  • Changed the Open API Spec Tag from User to Users which will cause generated client changes
  • Standardized OperationIds, Command names, and request structure:
    • Renamed AddEmailCommand to CreateEmailCommand
    • Renamed AddPhoneNumberCommand to CreatePhoneCommand
    • Renamed AddLocationCommand to CreateLocationCommand
    • Renamed Users_GetEmailResendVerificationToken to Users_CreateEmailVerificationNonce
    • Changed the payload of Users_ResendEmailVerification to be an object instead of a string
    • Changed the payload of Users_VerifyEmail to be an object instead of a string
    • Renamed User_GetPhoneResendVerificationToken to Users_CreatePhoneVerificationNonce
    • Changed the payload of Users_ResendPhoneVerification to be an object instead of a string
    • Changed the payload of Users_VerifyPhone to be an object instead of a string
    • Changed the Email, Phones, and Membership collections from arrays to objects to support future paging