Skip to content

2023

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