List Access Tokens for a User
/api/v2/users/{id}/authorized_tokens/
Make a GET request to this resource to retrieve a list of access tokens associated with the selected user.
The resulting data structure contains:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
The count
field indicates the total number of access tokens
found for the given query. The next
and previous
fields provides links to
additional results if there are more than will fit on a single page. The
results
list contains zero or more access token records.
Results
Each access token data structure includes the following fields:
id
: Database ID for this access token. (integer)type
: Data type for this access token. (choice)url
: URL for this access token. (string)related
: Data structure with URLs of related resources. (object)summary_fields
: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created
: Timestamp when this access token was created. (datetime)modified
: Timestamp when this access token was last modified. (datetime)description
: Optional description of this access token. (string)user
: The user representing the token owner (id)token
: (string)refresh_token
: (field)application
: (id)expires
: (datetime)scope
: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string)
Sorting
To specify that access tokens are returned in a particular
order, use the order_by
query string parameter on the GET request.
?order_by=name
Prefix the field name with a dash -
to sort in reverse:
?order_by=-name
Multiple sorting fields may be specified by separating the field names with a
comma ,
:
?order_by=name,some_other_field
Pagination
Use the page_size
query string parameter to change the number of results
returned for each request. Use the page
query string parameter to retrieve
a particular page of results.
?page_size=100&page=2
The previous
and next
links returned with the results will set these query
string parameters automatically.
Searching
Use the search
query string parameter to perform a case-insensitive search
within all designated text fields of a model.
?search=findme
(Added in Ansible Tower 3.1.0) Search across related fields:
?related__search=findme
Request
- application/json
-
page: integer
A page number within the paginated result set.
-
page_size: integer
Number of results to return per page.
-
search: string
A search term.
Response
- application/json
200 Response
object
-
application(required):
integer
Title:
Application
-
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
expires:
string(date-time)
Title:
Expires
Read Only:true
-
id:
integer
Title:
Id
Read Only:true
-
modified:
string
Title:
Modified
Read Only:true
-
refresh_token:
string
Title:
Refresh token
Read Only:true
- related: string
-
scope:
string
Title:
Scope
Default Value:write
Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. -
summary_fields:
string
Title:
Summary fields
Read Only:true
-
token:
string
Title:
Token
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
user:
integer
Title:
User
Read Only:true
The user representing the token owner