<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M74D8PB" height="0" width="0" style="display:none;visibility:hidden">
Loading
Skip to NavigationSkip to Main Content

Use Okta Advanced Server Access API Collections With Postman

Advanced Server Access

Overview

Administrators can use Postman to run Okta Advanced Server Access (ASA) API collections. Set up the Okta Advanced Server Access API with Postman by creating a service user account, generating an API key, obtaining a bearer token, and configuring the Postman environment.

Applies To

  • Okta Identity Engine (OIE)
  • Okta Classic Engine
  • Okta Advanced Server Access (ASA)
  • Postman
  • API

Solution

How does an administrator set up the Okta Advanced Server Access API with Postman?

 

Configure the Okta Advanced Server Access API with Postman by creating a service user, generating a bearer token, and importing the API collection by following these steps.

  1. Log in to the Okta Advanced Server Access application from the Okta dashboard.
  2. Create a group with an admin role if one does not already exist. Navigate to Groups under the Directory section, click Create New Group, enter a Group Name (for example, ServiceAdmins), and click Create Group.
  3. Click Groups, click Details, click Team Roles, select Admin, and click Update Roles.
  4. Create a new service user account and add it to the admin group. Click Users, select the Service Accounts tab, click Create Service User, enter a new Username, and click Create Service User.
  5. Navigate to Groups, select the newly created group with the admin role, click the Users tab, click Add User to Group, and click Add User.

NOTE: Only administrators can list their teams' settings or update these using GET/PUT on /v1/teams/{{asa-team}}/settings.

  1. Generate a new API key and secret using the newly created service user. Click Users, click Service Users, and click the newly created service user.
  2. Click Create API Key under the API Keys section.

NOTE: Keep the API key and secret safe and secure.

  1. Generate a bearer_token using curl on the local machine. For example, open a terminal on macOS and run the following command:
curl -v -X POST \
-H "Content-Type: application/json" \
--data '{
"key_id": "api-key-id-here",
"key_secret": "api/secret/here"
}' \
https://app.scaleft.com/v1/teams/"team_name"/service_token
  1. Save the generated bearer_token securely for later use.
  2. Fork this Postman API collection (Advanced Server Access > Attributes) to the environment.
  3. Open Postman, navigate to Advanced Server Access API, click article:users, and select Get List the ASA Users for a team.
  4. Click the Authorization tab in the right pane and change the type to Bearer Token.
  5. Paste the copied bearer token into the Token field on the right.
  6. Run the GET commands to test the configuration. For example:
    • GET team users list: {{baseUrl}}/v1/teams/"team_name"/users
    • GET projects list: {{baseUrl}}/v1/teams/"team_name"/projects

Successfully retrieving the users and projects list confirms the Okta Advanced Server Access API setup in Postman.

Related References

Loading
Use Okta Advanced Server Access API Collections With Postman | Okta Support