Read All Scopes (Resource)
GET {{apiPath}}/environments/{{envID}}/resources/{{resourceID}}/scopes
To get the list of scopes associated with a specified resource, the GET /environments/{{envID}}/resources/{{resourceID}}/scopes
operation returns data for the scopes associated with the resource entity ID specified in the request URL.
Note: To get all scopes for all resources, you can use GET /environments/{{envID}}/resources
with the ?expand=scopes
query parameter appended to the request. The response data lists all scopes and shows the scope sub-resource data in the _embedded
section of the response.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
expand | string | Lists all scopes for all resources and shows the scope sub-resource data in the _embedded section of the response. |
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes"}},"_embedded":{"scopes":[{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/67db9776-afc2-40c3-938e-349b21ef9a55"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"67db9776-afc2-40c3-938e-349b21ef9a55","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:read:user","description":"Ability for the user to retrieve their own user identity and all attributes","schemaAttributes":["*"],"resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/80e762a8-55f5-470a-b203-c85fa9fdd162"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"80e762a8-55f5-470a-b203-c85fa9fdd162","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:update:user:name-only","description":"Access control scope to limit update to name only","schemaAttributes":["name.family","name.middle","name.given"],"resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"createdAt":"2021-04-19T20:57:42.127Z","updatedAt":"2021-04-19T21:00:57.571Z"},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/bafc2d76-91e2-4f78-a706-ceb641f86d67"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"bafc2d76-91e2-4f78-a706-ceb641f86d67","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:update:user","description":"Ability for the user to modify the attributes of their own user identity","schemaAttributes":["*"],"resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/45cd01da-a65d-4e2e-974b-a2104d4c6450"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"45cd01da-a65d-4e2e-974b-a2104d4c6450","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:update:userMfaEnabled","description":"Ability for a user to enable and disable multi-factor authentication for their own user identity","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/ca118588-0ad4-4543-ae82-c9cf3b4bc105"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"ca118588-0ad4-4543-ae82-c9cf3b4bc105","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:validate:userPassword","description":"Ability for a user to verify that a submitted password matches the one stored for their own user identity","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/ce53b847-de04-4263-8002-7f61858c860f"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"ce53b847-de04-4263-8002-7f61858c860f","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:reset:userPassword","description":"Ability for a user to add or change passwords for their own user identity using the /password end point","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/c3db58ac-503d-493b-98c7-f26170f5cbdb"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"c3db58ac-503d-493b-98c7-f26170f5cbdb","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:read:userPassword","description":"Ability for a user to check the password status (expired, locked, etc) of their own password","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/760b1244-eb46-4892-a4a7-4ac690fe53c4"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"760b1244-eb46-4892-a4a7-4ac690fe53c4","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:read:device","description":"Ability for the user to retrieve properties for their own multi-factor authentication devices","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/a4d9fce6-fb9e-445c-a419-087cf8c36ae0"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"a4d9fce6-fb9e-445c-a419-087cf8c36ae0","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:update:device","description":"Ability for the user to update properties for their own multi-factor authentication devices","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/4cff30a3-15ea-46b2-94a3-c7cea942597a"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"4cff30a3-15ea-46b2-94a3-c7cea942597a","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:create:device","description":"Ability for the user to add their own multi-factor authentication devices","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/7dd08cb4-bf99-4186-bad3-b8f84e6678de"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"7dd08cb4-bf99-4186-bad3-b8f84e6678de","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:delete:device","description":"Ability for the user to remove their own multi-factor authentication devices","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/30d8f2bc-e7b6-457b-bd1f-c0d914d55bb4"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"30d8f2bc-e7b6-457b-bd1f-c0d914d55bb4","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:read:userLinkedAccounts","description":"Read linked accounts for users","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/a3db1605-8d0f-4b79-929c-c342da84121f"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"a3db1605-8d0f-4b79-929c-c342da84121f","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:delete:userLinkedAccounts","description":"Delete linked accounts for users","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/e620535c-e3da-48be-ba9c-999b2f747d40"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"e620535c-e3da-48be-ba9c-999b2f747d40","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:create:pairingKey","description":"Creates a pairing key for user","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/ab56fbe2-254a-4fc0-acf9-314c86c9e4db"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"ab56fbe2-254a-4fc0-acf9-314c86c9e4db","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:delete:pairingKey","description":"Deletes a pairing key for user","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/17e45f29-e04f-4cd1-af0a-989d72cb0440"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"17e45f29-e04f-4cd1-af0a-989d72cb0440","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:read:pairingKey","description":"Reads a pairing key for user","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/24a10c67-611e-43b6-8d1d-daedd1900522"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"24a10c67-611e-43b6-8d1d-daedd1900522","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:read:sessions","description":"Reads a session for a user","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/bf2c1f69-f4e9-4efa-9e74-2ee902ab4d74"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"bf2c1f69-f4e9-4efa-9e74-2ee902ab4d74","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:delete:sessions","description":"Deletes a session for a user","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/aabeab17-9890-4fe6-add9-4efeac8628ae"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"aabeab17-9890-4fe6-add9-4efeac8628ae","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:read:userConsent","description":"Read a consent for a user","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf/scopes/1bd8e0d9-b932-4631-9c47-37abda41c015"},"resource":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"1bd8e0d9-b932-4631-9c47-37abda41c015","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"p1:verify:user","description":"Verify a user","resource":{"id":"faac7db8-67ce-44aa-8ae0-5ae672f5b8bf"}}]},"count":20,"size":20}