List properties or includes

get https://{hostname}/identity-management/v3/user-admin/properties

This operation lists the properties and includes for the current account or other managed accounts using the accountSwitchKey parameter. Include the groupId parameter in your request to filter the results by group. The response returns a list of propertyId regardless of whether they represent a property or include in PAPI. To learn more, see Manage access to properties and includes.

Response

Response body

array of objects

object

actions

object

Specifies activities available for the group.

groupId

integer

required

≥ 0

Unique identifier for each group. It filters down results to properties in the specified group.

groupName

string

required

length ≥ 1

Descriptive label for the group.

propertyId

integer

required

≥ 0

Unique identifier for a property or include. This is what PAPI refers to as an assetId. Note there’s a discrepancy between how PAPI and Identity and Access Management refer to propertyId values. To learn more, see Manage access to properties and includes.

propertyName

string

required

length ≥ 1

Name of the property created in PAPI, or the includeName when creating an include. To learn more, see Manage access to properties and includes.

propertyTypeDescription

string

required

length ≥ 1

Identifies the product-type such as On Demand Media, Site, Application, Live Media Streams, or NetStorage.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/identity-management/v3/user-admin/properties \
3
     --header 'accept: application/json'


xxxxxxxxxx
22
 
1
[
2
  {
3
    "actions": {
4
      "move": true
5
    },
6
    "groupId": 12345,
7
    "groupName": "Digital Company",
8
    "propertyId": 99999999,
9
    "propertyName": "0rb-digital-company-01.com",
10
    "propertyTypeDescription": "On Demand Media"
11
  },
12
  {
13
    "actions": {
14
      "move": true
15
    },
16
    "groupId": 32145,
17
    "groupName": "Internet Company",
18
    "propertyId": 88888888,
19
    "propertyName": "0rb-internet-company-01.com",
20
    "propertyTypeDescription": "On Demand Media"
21
  }
22
]

200The response provides the assets.