Overview

Reference documentation for the ForgeRock® Identity Management Self-Service REST API.

Note

This guide is reference documentation for IDM's self-contained service. If you are using the platform-based service using trees, see the Platform Self-Service Guide instead.

If you are just getting started, we recommend the platform-based version of self-service.

Quick Start

 Self-Service Overview Understand Self-Service Processes	 Self-Registration Configure User Self-Registration	 Social Registration Configure Registration Using Social Identity Providers
 Progressive Profile Progressive Profile Completion	 Password Reset Password Reset Process	 Username Retrieval Configure Username Retrieval
 Additional Configuration Additional configuration options for additional features such as reCAPTCHA, notifications, and the End User UI	 Custom Stages Add a Custom Stage to Self-Service	 Stage Reference Reference appendix of available self-service stages
 Social Identity Reference Reference appendix of available Social Identity Provider configurations

ForgeRock Identity Platform™ serves as the basis for our simple and comprehensive Identity and Access Management solution. We help our customers deepen their relationships with their customers, and improve the productivity and connectivity of their employees and partners. For more information about ForgeRock and about the platform, see https://www.forgerock.com.

This guide is intended for anyone developing a self-service application that acts as a client of ForgeRock Identity Management (IDM).

This guide is written with the expectation that you already have basic familiarity with the following topics:

REST APIs
JavaScript Object Notation (JSON) and basic IDM configuration