The gateway role assignments service provides functionality to assign role assignments to a gateway so that the gateway can access the PingOne services it needs. Only gateway resources with a type property value of PING_FEDERATE can have assigned platform roles.

The examples that follow show common actions to manage to create, read, update and delete gateway role assignments. For more information, see Roles. You need the Environment Admin role to perform operations on gateway role assignments entities.

Gateway role assignments data model

Property Description A string that specifies the application resource associated with the role assignment resource. A string that specifies the environment associated with the gateway.
id A string that specifies the gateway role assignment ID. A string that specifies the role ID. A string that specifies the role assignment scope ID.
scope.type A string that specifies the type of resource defining the scope of the Role assignment. Options are ORGANIZATION, ENVIRONMENT, and POPULATION.

Response codes

Code Message
200 Successful operation.
201 Successfully created.
204 Successfully removed. No content.
400 The request could not be completed.
401 You do not have access to this resource.
404 The requested resource was not found.