Manage Users in GrantsConnect API

Users that can view or approve grants can be maintained within the GrantsConnect API without going directly into the system.

New team members or users can be added by including them in a monthly HR file. They can also be manually added.

  1. Call POST api/client/v1/grantmanagerusers/userbyemail to determine if the user exists. If they do, a userId will be returned.

  2. If the user does not exist (i.e., no userId), then call POST api/client/v1/grantmanagerusers/addUser to add a new Grant Manager to the system.

    Note: Be sure to include the JSON body in the request to pass user information to the endpoint.

If a user is already available in the system, the roles to which they are assigned can be determined using the steps below.

  1. Call POST api/client/v1/grantmanagerusers/userbyemail to find the individual’s userId.

  2. Call GET api/client/v1/grantmanagerusers/roles/{userId} to return a list of all roles associated with the given userId.

If a user is not currently in a specific role, they can be assigned to it using the steps below.

  1. Call POST api/client/v1/grantmanagerusers/userbyemail to find the individual’s userId.

  2. Call GET api/client/v1/roles to retrieve a list of roles in the organization's account.

  3. Find the ID of the role (i.e., roleId) to use.

  4. Call POST api/client/v1/roles/{roleId}/addUserToRole/{userId} to add the userId to the roleId.

Tip: If an existing user is assigned to the same role, retrieve the roleId assigned to them and then proceed with calling POST api/client/v1/roles/{roleId}/addUserToRole/{userId} to add the new user to this role.

A user can be unassigned from a specific role using the steps below. Note that this does not delete the user from the system.

  1. Call POST api/client/v1/grantmanagerusers/userbyemail to find the individual’s userId.

  2. Call GET api/client/v1/grantmanagerusers/roles/{userId} to return a list of all roles associated with the given userId.

  3. Call DELETE api/client/v1/roles/{roleId}/removeUserFromRole/{userId} to remove this userId from the specified roleId.

In the instance that an employee leaves the organization or is no longer associated with the account, the steps below can be used to offboard them from the GrantsConnect system.

  1. Call POST api/client/v1/grantmanagerusers/userbyemail to find the individual’s userId.

  2. Call GET api/client/v1/grantmanagerusers/roles/{userId} to return a list of all roles associated with the given userId.

  3. Call DELETE api/client/v1/roles/{roleId}/removeUserFromRole/{userId} to remove this userId from the specified roleId.

    Note: Do this for every role to which the user is assigned.

  4. If the user has access to any workflow levels, refer to the Update or remove a user from workflows instructions to remove them from each workflow.

Although this removes the user from all roles and workflows, they will need to be manually deactivated in GrantsConnect. An API endpoint is not currently available to formally deactivate users.