How do I count the number of users in my ForgeRock deployment?

Overview

This article outlines different approaches you can take to count users in your deployment. Depending on how you define and store users, some approaches may be more suitable to use than others. 

The following options are available:

• Count all objects within a particular branch of the directory - you can use this option as long as all users are stored within the same branch of the directory and the branch is not used for any other objects (that is, only users are stored there).
• Count all objects in the directory with a user based objectClass search filter - you can use this option if the objectClass used in the search filter is only used for real people objects.
• Count all objects in the directory with a uid based RDN - you can use this option if you use uid based RDNs, for example, uid=jdoe.
• Counting managed/user objects in IDM - you can use this option to count all users in your repository providing you are using a JDBC repository. If you use a DS repository, you should use one of the DS options outlined above.

Additionally, the documentation demonstrates how to count users who have been active within a specific time period. See Active Accounts for further information on setting this up and then searching for active users. 

Counting all objects within a particular branch of the directory

You can count all objects within a particular branch of the directory using a ldapsearch command such as the following:

• DS 7.1 and later: $ ./ldapsearch --hostname localhost --port 1636 --useSsl --usePkcs12TrustStore /path/to/ds/config/keystore --trustStorePassword:file /path/to/ds/config/keystore.pin --bindDN uid=admin --bindPassword password --baseDN ou=people,dc=example,dc=com --searchScope base "(objectclass=*)" numsubordinates
• DS 7: $ ./ldapsearch --hostname localhost --port 1636 --useSsl --usePkcs12TrustStore /path/to/ds/config/keystore --trustStorePasswordFile /path/to/ds/config/keystore.pin --bindDN uid=admin --bindPassword password --baseDN ou=people,dc=example,dc=com --searchScope base "(objectclass=*)" numsubordinates
• Pre-DS 7: $ ./ldapsearch --port 1389 --bindDN "cn=Directory Manager" --bindPassword password --baseDN ou=people,dc=example,dc=com --searchScope base "(objectclass=*)" numsubordinates

Example response:

Where this example shows there are 1027 objects (users) in the ou=people branch.

As you can see, there is no distinction on the type of object, which is why this approach only works if the branch is used solely for users.

Counting all objects in the directory with a user based objectClass​​​​​​​ search filter

You can count all objects in the directory that match a given search filter using a query such as the following providing you use the default schema objectClass=inetOrgPerson:

• DS 7.1 and later: $ ./ldapsearch --hostname localhost --port 1636 --useSsl --usePkcs12TrustStore /path/to/ds/config/keystore --trustStorePassword:file /path/to/ds/config/keystore.pin --bindDN uid=admin --bindPassword password --baseDN dc=example,dc=com --countentries objectClass=inetOrgPerson
• DS 7: $ ./ldapsearch --hostname localhost --port 1636 --useSsl --usePkcs12TrustStore /path/to/ds/config/keystore --trustStorePasswordFile /path/to/ds/config/keystore.pin --bindDN uid=admin --bindPassword password --baseDN dc=example,dc=com --countentries objectClass=inetOrgPerson
• Pre-DS 7: $ ./ldapsearch --port 1389 --bindDN "cn=Directory Manager" --bindPassword password --baseDN dc=example,dc=com --countentries objectClass=inetOrgPerson

Example response:

Where this example shows there are 874 objects (users) that satisfy the search filter.

This approach will not work if you use the specified objectClass for real people objects as well as non-real person objects.

This example query is also useful for determining the number of users protected by AM. 

Counting all objects in the directory with a uid based RDN

You can use a query such as the following to return a total count of all users (with uid based RDNs) along with the DNs and user ID values of them all:

• DS 7.1 and later: $ ./ldapsearch --hostname localhost --port 1636 --useSsl --usePkcs12TrustStore /path/to/ds/config/keystore --trustStorePassword:file /path/to/ds/config/keystore.pin --bindDN uid=admin --bindPassword password --baseDN dc=example,dc=com --searchScope sub --countEntries "(uid=*)" uid
• DS 7: $ ./ldapsearch --hostname localhost --port 1636 --useSsl --usePkcs12TrustStore /path/to/ds/config/keystore --trustStorePasswordFile /path/to/ds/config/keystore.pin --bindDN uid=admin --bindPassword password --baseDN dc=example,dc=com --searchScope sub --countEntries "(uid=*)" uid
• Pre-DS 7: $ ./ldapsearch --port 1389 --bindDN "cn=Directory Manager" --bindPassword password --baseDN dc=example,dc=com --searchScope sub --countEntries "(uid=*)" uid

Example response:

Where this example shows there are 2467 users.

Any users with a non-uid based RDN will not be returned with this query.

This example query is also useful for determining the number of users protected by AM. 

Counting managed/user objects in IDM

You can use one of these REST calls to return a count of all users in a JDBC repository if you use the 'user' managed object for users. If you use a different managed object, for example, person, you should adjust the URL being called. For example, in IDM 7:  "http://localhost:8080/openidm/managed/person?_queryId=query-all-ids"

• IDM 7 and later: $ curl -X GET -H "X-OpenIDM-Username: openidm-admin" -H "X-OpenIDM-Password: openidm-admin" -H "Accept-API-Version: resource=1.0" "http://localhost:8080/openidm/managed/user?_queryId=query-all-ids"

Example response, which indicates you have 729 users:{   "result": [        {"_id":"ea018740-50ce-4742-b255-b3592eae613f","_rev":"000000006a72d15f"},         {"_id":"bddb135d-f6b7-4933-bb9e-525d436d48bb","_rev":"00000000d895bbb1"}, ...     ],     "resultCount": 729,     "pagedResultsCookie": null,     "totalPagedResultsPolicy": "NONE",     "totalPagedResults": -1,     "remainingPagedResults": -1 }

• Pre-IDM 7: $ curl -X GET -H "X-OpenIDM-Username: openidm-admin" -H "X-OpenIDM-Password: openidm-admin" "http://localhost:8080/openidm/managed/user?_queryId=query-all-count"

Example response, which indicates you have 729 users:{   "result": [         {             "total": 729         }     ],     "resultCount": 1,     "pagedResultsCookie": null,     "totalPagedResultsPolicy": "NONE",     "totalPagedResults": -1,     "remainingPagedResults": -1 }

See Also

FAQ: Users in AM

DS LDAP Search

IDM Managed Users

Related Training

N/A

Related Issue Tracker IDs

N/A