A newer version is available; see the version menu above for details.
The role-based access control (RBAC) service enables you to manage users, directory groups, and roles.
Note: In addition to the endpoints on this page, there are some endpoints that you can use to check the health of the RBAC service. These are available through the Status API documentation.
Forming RBAC Service Requests
To make well-formed HTTP(S) requests to the RBAC v1 API, use the following port and path:
In the request path,
localhost:4433 are the machine and port if you’re making the call from the console machine. If you’re not making the call from the console machine, then use the console machine’s hostname in place of
POST requests with non-empty bodies should have the
Content-Type header set to
The service consists of the endpoints below.
RBAC enables you to manage local users as well as those who are created remotely, on a directory service. With the users endpoints, you can get lists of users, and you can create new local users.
groups endpoints enable you to get lists of groups and add a new remote user group.
By assigning roles to users, you can manage them in sets that are granted access permissions to various Puppet Enterprise (PE) objects. This makes tracking user access more organized and easier to manage. The
roles endpoints enable you to get lists of roles and create new roles.
You assign permissions to user roles to manage user access to objects in PE. The
permissions endpoints enable you to get information about available objects and the permissions that can be constructed for those objects. You can also check an array of permissions.
RBAC enables you to connect with a directory service and work with users and groups already established on your directory service. The
ds endpoints enable you to get information about the directory service, test your directory service connection, and replace directory service connection settings.
When users forget passwords or lock themselves out of PE by attempting to log in with incorrect credentials 10 times, you’ll have to generate a password reset token for them. The
password endpoints enable you to generate password reset tokens for a specific user or with a token that contains a temporary password in the body.
Additional RBAC Service Information
Describes the errors you might receive when making RBAC service calls.
Describes RBAC configuration options for things, such as how long a password reset token remains valid or how long before a session will time out.