GET /api/users/:user_id/personal_access_tokens
ユーザーのすべてのパーソナルアクセストークンを一覧表示

GET /api/users/988725679/personal_access_tokens
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2019-11-07 08:45:43 UTC",
      "updated_at": "2019-11-07 08:45:43 UTC",
      "id": 2,
      "name": "Personal Access Token 9",
      "expires_at": "2019-11-17 08:45:43 UTC",
      "active?": true,
      "user_id": 988725679,
      "last_used_at": null
    }
  ]
}

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

user_id
必須

ユーザーの ID

Validations:

  • Must be a String

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

1 から始まるページ番号

Validations:

  • Must be a number.

per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.


GET /api/users/:user_id/personal_access_tokens/:id
ユーザーのパーソナルアクセストークンを表示

GET /api/users/988725680/personal_access_tokens/3
200
{
  "created_at": "2019-11-07 08:45:43 UTC",
  "updated_at": "2019-11-07 08:45:43 UTC",
  "id": 3,
  "name": "Personal Access Token 10",
  "expires_at": "2019-11-17 08:45:43 UTC",
  "active?": true,
  "user_id": 988725680,
  "last_used_at": null
}

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

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
必須

ユーザーの ID

Validations:

  • Must be a String


POST /api/users/:user_id/personal_access_tokens
ユーザーのパーソナルアクセストークンを作成

POST /api/users/988725681/personal_access_tokens
{
  "personal_access_token": {
    "name": "foreman@example.com",
    "expires_at": "2019-12-05T08:45:43Z"
  }
}
201
{
  "token_value": "SK-PrjW98OTY1h8QTY9hUA",
  "created_at": "2019-11-07 08:45:43 UTC",
  "updated_at": "2019-11-07 08:45:43 UTC",
  "id": 5,
  "name": "foreman@example.com",
  "expires_at": "2019-12-05 08:45:43 UTC",
  "active?": true,
  "user_id": 988725681,
  "last_used_at": null
}

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

user_id
必須

ユーザーの ID

Validations:

  • Must be a String

personal_access_token
必須

Validations:

  • Must be a Hash

personal_access_token[name]
必須

Validations:

  • Must be a String

personal_access_token[expires_at]
任意 , nil可

有効期限

Validations:

  • Must be a DateTime


DELETE /api/users/:user_id/personal_access_tokens/:id
ユーザーのパーソナルアクセストークンを取り消し

DELETE /api/users/988725678/personal_access_tokens/1
{
  "personal_access_token": {}
}
200
{
  "id": 1,
  "revoked": true,
  "token": "$2a$05$fe5dbbcea5ce7e2988b8cu51c9MzSrcUh55GAHmb3QDsL5XyXKZVe",
  "name": "Personal Access Token 8",
  "expires_at": "2019-11-17T08:45:43.434Z",
  "last_used_at": null,
  "user_id": 988725678,
  "created_at": "2019-11-07T08:45:43.437Z",
  "updated_at": "2019-11-07T08:45:43.462Z"
}

パラメーター

パラメーター名 記述
location_id
任意

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
任意

Set the current organization context for the request

Validations:

  • Must be a Integer

id
必須

Validations:

  • Must be a String

user_id
必須

ユーザーの ID

Validations:

  • Must be a String