Retrieve a List of Attributes Used by an Application Using the Okta API
Last Updated:
Overview
Administrators can retrieve a list of attributes used by an application by making a GET request to the Okta Application Schema API endpoint. The response returns a composite schema comprising base and custom properties that define the user profile object.
Applies To
- Okta Identity Engine (OIE)
- Okta Classic Engine
- Okta API
- Applications
- API clients (such as Postman)
Solution
How do administrators retrieve a list of attributes used by an application using the Okta API?
Configure an API client, download the Okta API collections, and execute the schema retrieval command to view the application attributes.
- Install and integrate an API client (such as Postman) with Okta.
- Download the desired Okta API collections.
- Navigate to Schemas (Okta API) and select the Retrieve the default app user schema for an app API command.
- Enter the following endpoint and select Send:
Okta returns a 200 OK response containing the attribute data. Within the response parameters, the definitions object defines the user profile object through a composite schema of base and custom properties using a JavaScript Object Notation (JSON) path to reference subschemas. Okta defines and versions the #base properties, while the #custom properties remain extensible.
