PingOne Platform APIs

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. The organizations endpoints provide functions to read organizations resources.

Learn more about organizations in Introduction to PingOne, in the PingOne Admin Guide.

Assigning admin roles and permissions to this service

Admin role assignments determine access to PingOne APIs. When assigning admin roles to this service, refer to PingOne Permissions by Service for the service-specific permissions.

You can also choose to assign admin roles based on particular service resources. Refer to PingOne Permissions by Resource when assigning admin roles per service resources.

Admin assignments to roles are set by:

Refer to Roles Management for more information.

Organzations data model

Property Type Required Mutable Description

createdAt

Date

N/A

Read-only

The time the resource was created.

description

String

Optional

Mutable

The description of the organization.

id

String

Required

Immutable

The resource’s unique identifier.

name

String

Required

Mutable

The organization name, which must be provided and must be unique among all organizations in PingOne.

billingConnections.id

String

Required

Immutable

The list of the BillingConnection resource IDs for the organization.

type

String

Required

Mutable

The organization type. If the organization has any paid licenses, the type property value is set to PAID. Otherwise, the property value is set to TRIAL.

updatedAt

Date

N/A

Read-only

The time the resource was last updated.

Organizations events generated

Refer to Audit Reporting Events for the events generated.

Response codes

Code Message

200

Successful operation.

400

The request could not be completed.

401

You do not have access to this resource.

403

You do not have permissions or are not licensed to make this request.

404

The requested resource was not found.

Organizations errors

In addition to the general error codes, organization operations can return the following errors:

HTTP status Top‑level code Detail code When it happens and what the response contains

400

INVALID_REQUEST

None

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: A GET /organizations/{organizationId} request specifies an organization ID that cannot be parsed as a UUID

Details: None. The top-level code is INVALID_REQUEST even though the message text is the INVALID_DATA default message. A limit query parameter that is not an integer is silently replaced with the default page size rather than rejected. GET /organizations does not support a filter query parameter; a filter value is ignored.

500

UNEXPECTED_ERROR

None

Message: There was an unexpected error with the service. Please try again later.

When and details

When: GET /organizations supplies a cursor query parameter that cannot be decoded (the service decodes it as a Cassandra paging state hex string and an undecodable value raises an unhandled IllegalArgumentException)

Details: None.

403

ACCESS_FAILED

None

Message: The actor attempting to perform the request is not authorized.

When and details

When: The actor lacks the orgmgt:read:organization permission (GET operations)

Details: None.

403

ACCESS_FAILED

INSUFFICIENT_PERMISSIONS

Message: The request could not be completed. You do not have access to this resource.

When and details

When: The actor has the orgmgt:read:organization permission but no role assignment whose scope covers the target organization

Details: The actor attempting to perform the request is not authorized.

404

NOT_FOUND

None

Message: Unable to find organization: '<organizationId>'

When and details

When: A GET /organizations/{organizationId} request references an organization ID that does not exist

Details: None.

500

UNEXPECTED_ERROR

None

Message: There was an unexpected error with the service. Please try again later.

When and details

When: The operation fails unexpectedly while processing the request

Details: None. (For an internal OrganizationException, the top‑level message is the internal exception text instead of the standard default message.)