ForgeRock

ForgeRock Users API

Query user entitlement data and recommendations

Documentation GitHub OpenAPI

Operations 5

GET /api/users/{userId}/entitlements ForgeRock List user entitlements #

GET /api/users/{userId}/recommendations ForgeRock Get user recommendations #

GET /api/users List directory users #

POST /api/users Create a directory user #

POST /api/users/{userId} Perform a user action #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/forgerock-users-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Forgerock Users API
  contact:
    name: ForgeRock
    url: https://www.forgerock.com
  license:
    name: Proprietary
    url: https://www.forgerock.com/terms
  x-refined-note:
  - x-api differs across the merged source definitions and was not carried
  x-provider: forgerock
  version: '1.0'
  description: 'Operations tagged Users across 2 of this provider''s published API definitions: forgerock-autonomous-identity-openapi.yml, forgerock-directory-services-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{deployment}/autoid
  description: ForgeRock Autonomous Identity server
  variables:
    deployment:
      default: autoid.example.com
      description: The Autonomous Identity deployment hostname
- url: https://{deployment}/ds
  description: ForgeRock Directory Services HDAP endpoint
  variables:
    deployment:
      default: ds.example.com
      description: The DS deployment hostname
tags:
- name: Users
  description: Query user entitlement data and recommendations
paths:
  /api/users/{userId}/entitlements:
    get:
      operationId: listUserEntitlements
      summary: ForgeRock List user entitlements
      description: Retrieve all entitlements assigned to a specific user with their confidence scores and justification data.
      tags:
      - Users
      parameters:
      - name: userId
        in: path
        required: true
        description: The user identifier
        schema:
          type: string
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Offset'
      - name: confidenceThreshold
        in: query
        description: Filter by minimum confidence score
        schema:
          type: number
      responses:
        '200':
          description: List of user entitlements with confidence scores
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEntitlementList'
      security:
      - bearerAuth: []
    servers:
    - url: https://{deployment}/autoid
      description: ForgeRock Autonomous Identity server
      variables:
        deployment:
          default: autoid.example.com
          description: The Autonomous Identity deployment hostname
  /api/users/{userId}/recommendations:
    get:
      operationId: getUserRecommendations
      summary: ForgeRock Get user recommendations
      description: Get recommended entitlements for a user based on their attributes and the AI model's predictions.
      tags:
      - Users
      parameters:
      - name: userId
        in: path
        required: true
        description: The user identifier
        schema:
          type: string
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: Entitlement recommendations for the user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendationList'
      security:
      - bearerAuth: []
    servers:
    - url: https://{deployment}/autoid
      description: ForgeRock Autonomous Identity server
      variables:
        deployment:
          default: autoid.example.com
          description: The Autonomous Identity deployment hostname
  /api/users:
    get:
      operationId: listUsers
      summary: List directory users
      description: Query user entries in the directory. Supports CREST query filters which are translated to LDAP search operations with appropriate filter expressions.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/QueryFilter'
      - $ref: '#/components/parameters/PageSize_2'
      - $ref: '#/components/parameters/PagedResultsCookie'
      - $ref: '#/components/parameters/SortKeys'
      - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          description: List of user entries
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserQueryResult'
        '400':
          description: Invalid query filter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - bearerAuth: []
      - basicAuth: []
    post:
      operationId: createUser
      summary: Create a directory user
      description: Create a new user entry in the directory. The JSON resource is mapped to an LDAP entry with appropriate object classes and attributes.
      tags:
      - Users
      requestBody:
        required: true
        description: The user entry to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '201':
          description: User created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '400':
          description: Invalid user data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: User already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - bearerAuth: []
      - basicAuth: []
    servers:
    - url: https://{deployment}/ds
      description: ForgeRock Directory Services HDAP endpoint
      variables:
        deployment:
          default: ds.example.com
          description: The DS deployment hostname
  /api/users/{userId}:
    post:
      operationId: userAction
      summary: Perform a user action
      description: Perform actions on a user entry such as password reset or password change via _action query parameter.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/UserId'
      - name: _action
        in: query
        required: true
        description: The action to perform
        schema:
          type: string
          enum:
          - resetPassword
          - modifyPassword
      requestBody:
        description: Action-specific request body
        content:
          application/json:
            schema:
              type: object
              properties:
                oldPassword:
                  type: string
                  description: Current password (for modifyPassword)
                newPassword:
                  type: string
                  description: New password
      responses:
        '200':
          description: Action completed
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - bearerAuth: []
      - basicAuth: []
    servers:
    - url: https://{deployment}/ds
      description: ForgeRock Directory Services HDAP endpoint
      variables:
        deployment:
          default: ds.example.com
          description: The DS deployment hostname
components:
  schemas:
    UserEntitlementList:
      type: object
      properties:
        result:
          type: array
          items:
            type: object
            properties:
              entitlementId:
                type: string
              entitlementName:
                type: string
              application:
                type: string
              confidenceScore:
                type: number
              drivingAttributes:
                type: object
                additionalProperties:
                  type: string
              justification:
                type: string
                description: AI-generated justification for the assignment
        totalResults:
          type: integer
    RecommendationList:
      type: object
      description: Entitlement recommendations
      properties:
        result:
          type: array
          items:
            type: object
            properties:
              userId:
                type: string
              userName:
                type: string
              entitlementId:
                type: string
              entitlementName:
                type: string
              application:
                type: string
              confidenceScore:
                type: number
                description: Predicted confidence score
              drivingAttributes:
                type: object
                additionalProperties:
                  type: string
        totalResults:
          type: integer
    UserQueryResult:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/User'
        resultCount:
          type: integer
        pagedResultsCookie:
          type: string
        totalPagedResults:
          type: integer
    User:
      type: object
      description: A directory user entry mapped from LDAP to JSON via HDAP
      properties:
        _id:
          type: string
          description: User identifier (mapped from LDAP uid)
        _rev:
          type: string
          description: Entry revision for MVCC
          readOnly: true
        userName:
          type: string
          description: Login username
        givenName:
          type: string
          description: First name
        sn:
          type: string
          description: Surname / last name
        cn:
          type: string
          description: Common name (full name)
        mail:
          type: string
          format: email
          description: Email address
        telephoneNumber:
          type: string
          description: Phone number
        description:
          type: string
          description: User description
        memberOf:
          type: array
          description: Groups this user belongs to
          readOnly: true
          items:
            type: string
        userPassword:
          type: string
          format: password
          description: Password (write-only, stored hashed)
          writeOnly: true
    ErrorResponse:
      type: object
      description: Standard CREST error response
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
  parameters:
    Offset:
      name: offset
      in: query
      description: Offset for pagination
      schema:
        type: integer
        minimum: 0
        default: 0
    PageSize:
      name: maxResults
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        minimum: 1
        default: 25
    SortKeys:
      name: _sortKeys
      in: query
      description: Comma-separated sort fields
      schema:
        type: string
    PageSize_2:
      name: _pageSize
      in: query
      description: Number of results per page
      schema:
        type: integer
        minimum: 1
    UserId:
      name: userId
      in: path
      required: true
      description: The user identifier (maps to LDAP uid or _id)
      schema:
        type: string
    PagedResultsCookie:
      name: _pagedResultsCookie
      in: query
      description: Cookie from a previous page for server-side paging
      schema:
        type: string
    QueryFilter:
      name: _queryFilter
      in: query
      description: CREST query filter expression, translated to an LDAP filter (e.g., uid eq "jdoe" becomes (uid=jdoe))
      schema:
        type: string
    Fields:
      name: _fields
      in: query
      description: Comma-separated list of fields to return
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Authentication token for Autonomous Identity API
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication (for directory bind)
x-refined-from:
- forgerock-autonomous-identity-openapi.yml
- forgerock-directory-services-openapi.yml