Users

A user corresponds to a human or service user in an Okta Privileged Access team

Retrieve user details

Retrieves details about the current user

SecuritybearerAuth
Request
path Parameters
team_name
required
string

The name of your team

Responses
200

OK

get/v1/teams/{team_name}/current_user
Request samples 
Response samples 
application/json
{
  • "id": "305b1bd8-b783-4351-a2b6-204248c9ea46",
  • "name": "Jason.Compson.IV",
  • "team_name": "william-faulkner"
}
List all users for a team
Admin roles: 
  • pam_admin
  • resource_admin
  • security_admin
Lists all users for your team


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your team


 
query Parameters
contains
string
Only return results that include the specified value


 
count
integer <int32> 
The number of objects per page


 
descending
boolean
The object order


 
id
string
Only return results with the specified IDs


 
include_service_users
string
Only return service users in the results


 
offset
string
The offset value for pagination. The rel="next" and rel="prev" Link headers define the offset for subsequent or previous pages.


 
prev
boolean
The direction of paging


 
starts_with
string
Only return users with a name that begins with the specified value


 
status
string
Only return users with the specified status. Valid statuses: ACTIVE, DISABLED, and DELETED.


 
Responses 
200
OK


get/v1/teams/{team_name}/users
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      },
    • {
      },
    • {
      }
    ]
}
Retrieve a user
Admin roles: 
  • pam_admin
  • resource_admin
  • security_admin
Retrieves a user from your team


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your team


 
user_name
required
string
The username for an existing user


 
Responses 
200
OK


get/v1/teams/{team_name}/users/{user_name}
Request samples 
Response samples 
application/json
{
  • "deleted_at": null,
  • "details": {
    • "email": "jason.compson@example.com",
    • "first_name": "Jason",
    • "full_name": "Jason Compson IV",
    • "last_name": "Compson"
    },
  • "id": "305b1bd8-b783-4351-a2b6-204248c9ea46",
  • "name": "Jason.Compson.IV",
  • "status": "ACTIVE",
  • "team_name": "william-faulkner",
  • "user_type": "human"
}
List all groups for a user
Admin roles: 
  • pam_admin
  • resource_admin
  • security_admin
Lists all groups for a specified user


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your team


 
user_name
required
string
The username for an existing user


 
query Parameters
contains
string
Only return results that include the specified value


 
count
integer <int32> 
The number of objects per page


 
descending
boolean
The object order


 
id
string
Only return results with the specified IDs


 
ignore
string
Ignore groups with the specified names. This is case sensitive.


 
include_deleted
boolean
If true, include deleted groups in the results


 
offset
string
The offset value for pagination. The rel="next" and rel="prev" Link headers define the offset for subsequent or previous pages.


 
only_include_deleted
boolean
If true, only return deleted groups in the results


 
prev
boolean
The direction of paging


 
Responses 
200
OK


get/v1/teams/{team_name}/users/{user_name}/groups
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      }
    ]
}