PingOne Platform APIs

Platform SSO APIs

The PingOne SSO APIs provide the interface to manage your PingOne organization and the resources associated with your tenant environments. The SSO API can be thought of as the PingOne admin API, and it includes the following entities.

Organization and environments

Organizations

PingOne uses an organization-based model to define tenant accounts and their related entities. The organization is the top-level identifier. It defines your entire enterprise within the PingOne platform.

Environments

An organization contains one or more environments. Environments define separate working domains within an organization. Environments model regions within a large global enterprise and are the defining entity to segregate enterprise operations by functionality, staging environments, or configurations.

Identity management

Users

Users are unique entities that interact with the applications and services within the environment to which the they are assigned. User resources in PingOne are the full representation of a user profile, including the user’s relationships, roles, devices, and attributes. Users are associated with populations rather than defined within a population. The user’s association with a population is established as a property on the user resource.

Identity provider management

The identity provider endpoints manage external identity provider configurations to enable social login and inbound SAML login features in PingOne. An external identity provider configuration allows linked users to authenticate and gain access to PingOne resources using the login flow and credentials provided by the external identity provider.

Applications and resource grants

Applications

Applications in PingOne define the connection between the PingOne platform and the actual application (also thought of as the client configuration).

Resources

Resources represent the connections to external services, enabling secure access to PingOne resources and other defined external resources.

Roles, entitlements, and permissions

Roles

Roles, permissions, and entitlements are defined at the root of the platform, and these entitlements apply to all PingOne SSO APIs, regardless of domain. Roles are assigned to users, and these user roles include a scope property to grant the user permissions corresponding to the role. For example, a role of Identity Admin contains permissions allowing the subject to read and edit user data. When this role is assigned to a user, it can be assigned with the scope property that identifies a population or an environment to which the permissions apply.

Calls to the PingOne SSO APIs require an admin-level access token to authenticate the requests. A Worker app is an administrator connection that interacts with the PingOne APIs on your behalf. An access token from a Worker app gives you admin-level access to the PingOne APIs. A Worker app’s roles and permissions determine the authorized access to PingOne API resources.