Resources are the protected endpoints that applications request access to using OAuth 2 authorization services. For example, PingOne API is a defined resource that represents the PingOne APIs. PingOne also defines an openid resource that uses OpenID Connect scopes with the /{environmentId}/as/userinfo endpoint to request specific sets of information as claim values in the ID token. For more information about the userinfo endpoint requests, see Userinfo authorization requests. You can also define custom resources to associate with applications.

The examples that follow show common actions to find and manage resources entities. You need the Client Application Developer role to perform operations on resources entities.

Resources data model

Property Description
accessTokenValiditySeconds An integer that specifies the number of seconds that the access token is valid. If a value is not specified, the default is 3600. The minimum value is 300 seconds (5 minutes); the maximum value is 2592000 seconds (30 days).
audience A string that specifies a URL without a fragment or “@ObjectName” and must not contain “pingone” or “pingidentity” (for example, https://api.myresource.com). If a URL is not specified, the resource name is used.
createdAt The time the resource was created.
description A string that specifies the description of the resource.
environment.id A string that specifies the environment resource’s unique identifier associated with the resource.
id A string that specifies the resource’s unique identifier.
name A string that specifies the resource name, which must be provided and must be unique within an environment.
type A string that specifies the type of resource. Options are OPENID_CONNECT, PING_ONE_API, and CUSTOM. Only the CUSTOM resource type can be created. OPENID_CONNECT specifies the built-in platform resource for OpenID Connect. PING_ONE_API specifies the built-in platform resource for PingOne.
updatedAt The time the resource was last updated.

Resources core attribute data model

Property Description
sub A string that specifies the core claim for the new resource. The default value is ${user.id}.

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.