Organizations


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

Filtering data

GET requests that return organization resources support the sw (starts with) SCIM filtering expression. This filter can be appended to the request URL to fine-tune the response data. For example, this filter returns only the organizations in which the name attribute value starts with the letter “S”:

https://api.pingone.com/v1/organizations?filter=name%20sw%20%22S%22

These SCIM operators can be applied to the following attributes:

  • sw (starts with)

    Supported attributes: name

Note: These SCIM operators are not supported: eq (equal to), gt (greater than), lt (less than), ge (greater than or equal to), le (less than or equal to), in (includes), ne (not equal), co (contains), ew (ends with), pr (present, is a non-empty or non-null value), not (logical NOT), or (logical OR), and (logical AND). Populations do not support SCIM filtering expressions.

For more information about SCIM syntax and operators, see Conventions.

Organizations API operations

The organizations endpoints support the following operations:

For hands-on experience with the organizations API endpoints, click the Run in Postman button below to download a Postman collection that you can import and open in your local Postman application.

Organzations data model

Property Description
createdAt The time the resource was created.
description A string that specifies the description of the organization.
id A string that specifies the resource’s unique identifier.
name A string that specifies the organization name, which must be provided and must be unique among all organizations in PingOne.
billingConnections.id A string that specifies the list of the BillingConnection resource IDs for the organization.
updatedAt The time the resource was last updated.

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.

Endpoint examples

Get organizations

The following sample shows the GET /organizations operation to return all organizations defined for the current account:

curl -X GET "https://api.pingone.com/v1/organizations" \
-H "Authorization: Bearer jwtToken"

Get one organization

The following sample shows the GET /organizations/{organizationId} operation to return data only for the organization resource identified by its ID in the request URL.

curl -X GET "https://api.pingone.com/v1/organizations/{organizationId}" \
-H "Authorization: Bearer jwtToken"

The response data shows the organization resource data.

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/organizations/000cf493-ee38-4373-9a28-370f234f0c06"
        },
        "environments": {
            "href": "https://api.pingone.com/v1/organizations/000cf493-ee38-4373-9a28-370f234f0c06/environments"
        }
    },
    "id": "000cf493-ee38-4373-9a28-370f234f0c06",
    "name": "SYNTHETICS-Org",
    "createdAt": "2018-07-20T14:23:43.324Z",
    "updatedAt": "2018-07-20T14:23:43.324Z"
}