Create a Group and Add a User

Number of APIs: 6

This activity shows you how to create a group and assign a user to that group.

Prerequisites

Get an access token from the worker application that you created in Getting Started with the PingOne APIs. To get a token from a different worker application in an alternate sandbox environment, run the token request endpoint using the client ID and client secret of your chosen worker app to authenticate the request. For more information, see GET a Worker Application Access Token.

Workflow order of operations

To create a group and add a user, you must complete the following tasks:

1. Make a POST request to /environments/{{envID}}/groups to create a new group.

2. Make a POST request to /environments/{{envID}}/populations to create a new population resource.

3. Make a POST request to /environments/{{envID}}/users to create a user to assign to the new population resource.

4. Make a POST request to /environments/{{envID}}/users/{{GroupUseCaseUserID}}/memberOfGroups to add the new user to the group.

5. Make a GET request to /environments/{{envID}}/users?filter=memberOfGroups[id eq "{{UseCaseGroupID}}"] to return a list of all users in the group.

6. Make a GET request to /environments/{{envID}}/users/{{GroupUseCaseUserID}}?include=memberOfGroupNames to return a list of all groups associated with the specified user.

1. Step 1: Create a group POST {{apiPath}}/environments/{{envID}}/groups

2. Step 2: Create a population for users POST {{apiPath}}/environments/{{envID}}/populations

3. Step 3: Create a user POST {{apiPath}}/environments/{{envID}}/users

4. Step 4: Add user to group POST {{apiPath}}/environments/{{envID}}/users/{{GroupUseCaseUserID}}/memberOfGroups

5. Step 5: Read all users in a group GET {{apiPath}}/environments/{{envID}}/users?filter=memberOfGroups[id eq "{{UseCaseGroupID}}"]

6. Step 6: Read all group names for a user GET {{apiPath}}/environments/{{envID}}/users/{{GroupUseCaseUserID}}?include=memberOfGroupNames