List properties or includes
GET https://{{host}}/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.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
groupId | string | (Optional) Unique identifier for each group. To get this value, run the List groups operation. | |
accountSwitchKey | string | (Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"actions":{"move":true},"groupId":12345,"groupName":"Digital Company","propertyId":99999999,"propertyName":"0rb-digital-company-01.com","propertyTypeDescription":"On Demand Media"},{"actions":{"move":true},"groupId":32145,"groupName":"Internet Company","propertyId":88888888,"propertyName":"0rb-internet-company-01.com","propertyTypeDescription":"On Demand Media"}]