GET /api/users/988725700/personal_access_tokens 200 { "total": 1, "subtotal": 1, "page": 1, "per_page": 20, "search": null, "sort": { "by": null, "order": null }, "results": [ { "created_at": "2020-05-20 13:45:16 UTC", "updated_at": "2020-05-20 13:45:16 UTC", "id": 4, "name": "Personal Access Token 19", "expires_at": "2020-05-30 13:45:16 UTC", "active?": true, "user_id": 988725700, "last_used_at": null } ] }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
user_id required |
ID of the user Validations:
|
search optional |
filter results Validations:
|
order optional |
Sort field and order, eg. ‘id DESC’ Validations:
|
page optional |
Page number, starting at 1 Validations:
|
per_page optional |
Number of results per page to return Validations:
|
Field name | Type | Possible values |
---|---|---|
name | string | |
user_id | integer |
GET /api/users/988725701/personal_access_tokens/5 200 { "created_at": "2020-05-20 13:45:16 UTC", "updated_at": "2020-05-20 13:45:16 UTC", "id": 5, "name": "Personal Access Token 20", "expires_at": "2020-05-30 13:45:16 UTC", "active?": true, "user_id": 988725701, "last_used_at": null }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
user_id required |
ID of the user Validations:
|
POST /api/users/988725699/personal_access_tokens { "name": "foreman@example.com", "expires_at": "2020-06-17T13:45:15Z", "personal_access_token": { "name": "foreman@example.com", "expires_at": "2020-06-17T13:45:15Z" } } 201 { "token_value": "rkD8ELG-XDjYo8NP9-4tCw", "created_at": "2020-05-20 13:45:15 UTC", "updated_at": "2020-05-20 13:45:15 UTC", "id": 3, "name": "foreman@example.com", "expires_at": "2020-06-17 13:45:15 UTC", "active?": true, "user_id": 988725699, "last_used_at": null }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
user_id required |
ID of the user Validations:
|
personal_access_token required |
Validations:
|
personal_access_token[name] required |
Validations:
|
personal_access_token[expires_at] optional , nil allowed |
Expiry Date Validations:
|
DELETE /api/users/988725698/personal_access_tokens/1 { "personal_access_token": {} } 200 { "id": 1, "revoked": true, "token": "$2a$05$0716d9708d321ffb6a008ubr8D5S35xLlSFwbxGfj3Wvx3vrg956q", "name": "Personal Access Token 17", "expires_at": "2020-05-30T13:45:15.702Z", "last_used_at": null, "user_id": 988725698, "created_at": "2020-05-20T13:45:15.704Z", "updated_at": "2020-05-20T13:45:15.725Z" }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
user_id required |
ID of the user Validations:
|