Personal access tokens

>>>

GET /api/users/:user_id/personal_access_tokens
List all Personal Access Tokens for a user

Examples

GET /api/users/988725684/personal_access_tokens
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2019-02-20 13:34:48 UTC",
      "updated_at": "2019-02-20 13:34:48 UTC",
      "id": 6,
      "name": "Personal Access Token 10",
      "expires_at": "2019-03-02 13:34:48 UTC",
      "active?": true,
      "user_id": 988725684,
      "last_used_at": null
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
user_id
required

ID of the user

Validations:

  • Must be a String
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

paginate results

Validations:

  • Must be a String
per_page
optional

number of entries per request

Validations:

  • Must be a String
>>>

GET /api/users/:user_id/personal_access_tokens/:id
Show a Personal Access Token for a user

Examples

GET /api/users/988725685/personal_access_tokens/7
200
{
  "created_at": "2019-02-20 13:34:48 UTC",
  "updated_at": "2019-02-20 13:34:48 UTC",
  "id": 7,
  "name": "Personal Access Token 11",
  "expires_at": "2019-03-02 13:34:48 UTC",
  "active?": true,
  "user_id": 988725685,
  "last_used_at": null
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
user_id
required

ID of the user

Validations:

  • Must be a String
>>>

POST /api/users/:user_id/personal_access_tokens
Create a Personal Access Token for a user

Examples

POST /api/users/988725681/personal_access_tokens
{
  "name": "foreman@example.com",
  "expires_at": "2019-03-20T13:34:48Z",
  "personal_access_token": {
    "name": "foreman@example.com",
    "expires_at": "2019-03-20T13:34:48Z"
  }
}
201
{
  "token_value": "-PHcseDOBYip1GfUQmryYQ",
  "created_at": "2019-02-20 13:34:48 UTC",
  "updated_at": "2019-02-20 13:34:48 UTC",
  "id": 2,
  "name": "foreman@example.com",
  "expires_at": "2019-03-20 13:34:48 UTC",
  "active?": true,
  "user_id": 988725681,
  "last_used_at": null
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
user_id
required

ID of the user

Validations:

  • Must be a String
personal_access_token
required

Validations:

  • Must be a Hash
personal_access_token[name]
required

Validations:

  • Must be a String
personal_access_token[expires_at]
optional , nil allowed

Expiry Date

Validations:

  • Must be a DateTime
>>>

DELETE /api/users/:user_id/personal_access_tokens/:id
Revoke a Personal Access Token for a user

Examples

DELETE /api/users/988725682/personal_access_tokens/3
{
  "personal_access_token": {}
}
200
{
  "id": 3,
  "revoked": true,
  "token": "d8c3ca24091552c7360fac45422aa0c7506dc3e6",
  "name": "Personal Access Token 8",
  "expires_at": "2019-03-02T13:34:48.666Z",
  "last_used_at": null,
  "user_id": 988725682,
  "created_at": "2019-02-20T13:34:48.668Z",
  "updated_at": "2019-02-20T13:34:48.680Z"
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be a String
user_id
required

ID of the user

Validations:

  • Must be a String