Book
ForgeRock Identity Platform
Does not apply to Identity Cloud

Using the REST API in AM

This book provides information on using the REST API in AM and includes known issues (including solutions).


Printer friendly view

Table of Contents

  • 1 How do I update REST API calls after upgrading to a newer version of AM?
  • 2 How do I avoid common issues with REST calls in AM (All versions)?
  • 3 How do I understand the underlying REST call being used in web requests in Identity Cloud or AM (All versions)?
  • 4 How do I validate session tokens and obtain session details using the REST API in AM (All versions)?
  • 5 How do I retrieve user attributes from a session using the REST API in AM (All versions)?
  • 6 How do I update LDAP user attributes using the REST API in AM (All versions)?
  • 7 How do I assign password policies to a user when creating the user via the REST API in AM (All versions)?
  • 8 How do I unlock a user's account using the REST API in AM (All versions)?
  • 9 How do I change a user's password using the REST API in AM (All versions)?
  • 10 How do I create a policy in AM (All versions) using the REST API?
  • 11 How do I create and update an Agent in AM (All versions) using the REST API?
  • 12 How do I force REST API responses to always use lower case for attribute names in AM (All versions)?
  • 13 FAQ: REST API in AM
  • 14 How do I use the Postman collections that are provided for AM (All versions)?
  • 15 Known Issues
    • 15.1 400 response when adding or updating resources via REST or Amster when the resource name contains forward slashes in AM (All versions)
    • 15.2 400 response with json/users endpoint in AM (All versions) if username contains forward slash
    • 15.3 Minimum password length is 8 error in AM (All versions) when updating identities using the REST API