Read One Attribute

GET {{apiPath}}/environments/{{envID}}/schemas/{{schemaID}}/attributes/{{schemaAttrID}}

To get data for a single attribute resource, the the GET /environments/{{envID}}/schemas/{{schemaID}}/attributes/{{schemaAttrID}} operation returns data only for the attribute resource with the ID specified in the request URL.

Custom string attributes in user resource requests

You can use custom string attributes in a filtering expression to fine-tune the user response data. The following sample shows a GET /environments/{{envID}}/users request that returns users with a shirtSize custom attribute value set to Large.

curl -X "GET" "https://api.pingone.com/v1/environments/5caa81af-ec05-41ff-a709-c7378007a99c/users?filter=shirtSize%20eq%20%Large%22" \\
-H 'Content-type: application/json' \\
-H 'Authorization: Bearer {{accessToken}}'

In the Authorization request header field, the accessToken value is your full base64url-encoded JSON web token generated by the authentication service.

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/schemas/6497b7af-99d1-4217-8a82-057fcc3b7401/attributes/cc1ffe4e-9129-4fb0-8962-23c760c52aff"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"schema":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/schemas/6497b7af-99d1-4217-8a82-057fcc3b7401"}},"id":"cc1ffe4e-9129-4fb0-8962-23c760c52aff","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"officeLocation","displayName":"An optional property that specifies the display name of the attribute.","description":"An optional property that specifies the description of the new attribute.","schemaType":"CUSTOM","type":"STRING","unique":false,"enabled":false,"multiValued":false,"required":false,"schema":{"id":"6497b7af-99d1-4217-8a82-057fcc3b7401"}}