- URL:
- https://<root>/security/users
- Methods:
GET- Operations:
- Create User, Get Enterprise User, Update Enterprise User, Search Enterprise Users, Refresh User Membership
- Version Introduced:
- 10.2.1
Access requirements
Required privileges
The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
Description
The users resource is an umbrella for operations to manage members within the organization. This resource returns the total number of members in the organization.
As an administrator, you can register enterprise accounts for your organization by using the Create User operation. When automatic sign-in for users is disabled in the Security Configuration, registered enterprise accounts can sign in as members of the portal. This gives you full control on all the accounts within an organization.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access the users resource:
https://organization.example.com/<context>/portaladmin/security/users?f=pjsonJSON Response example
{
"currentRegisteredMembers": 25
}