Retrieve a collection resource

Request

Beta

okta.governance.collections.read

APP_ADMIN

Retrieves a collection resource with its details. Use the include query parameter to return additional properties such as resourceProfile, labels, and relatedApps.

Path

collectionIdstringrequired

Unique identifier for the collection

resourceIdstringrequired

Unique identifier for the resource

Query

includeArray of strings

The include query parameter returns additional properties in the response.

Items Enum Value	Description
labels	Returns governance labels associated with the resource
relatedApps	Returns related apps for group and push group resources. Ignored for app resources.
resourceProfile	Returns the resource profile details (name, label, logo) for the resource.

Example:include=labels

GET

/governance/api/v2/collections/{collectionId}/resources/{resourceId}

curl -i -X GET \
  'https://okta-subdomain.pixtulate.com/governance/api/v2/collections/{collectionId}/resources/{resourceId}?include=labels'

Responses

Response to a successful get resource collection operation

Bodyapplication/json

resourceOrnstring, (okta-resource-orn)(collection-resource-orn)required

The ORN identifier for a collection resource (app, group, or push group).

See the supported-resources endpoint.

resourceIdstring, (okta-resource-id), <= 20 characters(collection-resource-id)

The unique resource ID for this resource (app, group, or push group). Use this identifier to reference the resource in collection-resource API calls, such as GET/PUT/DELETE /v2/collections/{collectionId}/resources/{resourceId}.

_linksobject(collection-resource-links-v2)required

Links available on a resource within a resource collection

resourceProfileobject(resource-profile-v2)

A limited set of properties from the resource's profile

resourceConfigurationobject(collection-resource-configuration)read-only

Server-resolved configuration details for this resource within the collection

entitlementsArray of objects(entitlements-full)

Collection of entitlements with associated values

pushGroupsArray of objects(collection-push-groups)

List of push groups associated with an app collection resource

labelsArray of objects(governance-labels)

The governance labels associated with this resource

relatedAppsArray of objects(related-apps)

The apps related to this resource. Only populated for GROUP type resources. For GROUP resources with hasPushMapping: true, these are apps that this group is mapped to through push group. For GROUP resources with hasPushMapping: false, these are apps assigned to this group.

Response

Response showing an app resource with entitlements

{
  "resourceOrn": "orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ",
  "resourceId": "res789067asg6asdf7g",
  "resourceConfiguration": {
    "entitlementManagementEnabled": true,
    "type": "APPLICATION",
    "counts": { … }
  },
  "entitlements": [
    { … },
    { … }
  ],
  "_links": {
    "resource": { … },
    "entitlements": { … }
  }
}