移動先

• リクエスト
• レスポンス

ユーザーのアクセス・トークンの作成

post

/api/v2/users/{id}/tokens/

次のアクセス・トークン・フィールドを指定してこのリソースに対してPOSTリクエストを行って、このユーザーに関連付けられる新しいアクセス・トークンを作成します。

• description: このアクセス・トークンのオプションの説明。(文字列、デフォルト="")

• application: (id、デフォルト=``)

• scope: 許可されるスコープとして、さらにユーザーの権限を制限します。許可されるスコープ['read', 'write']が指定された、スペースで区切られた単純な文字列である必要があります。(文字列、デフォルト="write")

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• id(必須): 文字列

本文()

ルート・スキーマ : OAuth2Token

型: object

ソースを表示

• application: 整数
  タイトル: Application
• created: 文字列
  タイトル: Created

  読取り専用: true
• description: 文字列
  タイトル: Description
• expires: 文字列(日付-時間)
  タイトル: Expires

  読取り専用: true
• id: 整数
  タイトル: Id

  読取り専用: true
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• refresh_token: 文字列
  タイトル: Refresh token

  読取り専用: true
• related: 文字列
  タイトル: Related

  読取り専用: true
• scope: 文字列
  タイトル: Scope

  デフォルト値: write

  許可されるスコープ。さらにユーザーの権限を制限します。許可されるスコープ['read', 'write']が指定された、スペースで区切られた単純な文字列である必要があります。
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• token: 文字列
  タイトル: Token

  読取り専用: true
• type: 文字列
  タイトル: Type

  読取り専用: true
• url: 文字列
  タイトル: Url

  読取り専用: true
• user: 整数
  タイトル: User

  読取り専用: true

  トークンの所有者を表すユーザー

{
    "properties":{
        "application":{
            "title":"Application",
            "type":"integer",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "expires":{
            "format":"date-time",
            "readOnly":true,
            "title":"Expires",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"Id",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "refresh_token":{
            "readOnly":true,
            "title":"Refresh token",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scope":{
            "default":"write",
            "description":"Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].",
            "title":"Scope",
            "type":"string",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "token":{
            "readOnly":true,
            "title":"Token",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "user":{
            "description":"The user representing the token owner",
            "readOnly":true,
            "title":"User",
            "type":"integer"
        }
    },
    "type":"object"
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

201レスポンス

本文()

ルート・スキーマ : OAuth2Token

型: object

ソースを表示

• application: 整数
  タイトル: Application
• created: 文字列
  タイトル: Created

  読取り専用: true
• description: 文字列
  タイトル: Description
• expires: 文字列(日付-時間)
  タイトル: Expires

  読取り専用: true
• id: 整数
  タイトル: Id

  読取り専用: true
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• refresh_token: 文字列
  タイトル: Refresh token

  読取り専用: true
• related: 文字列
  タイトル: Related

  読取り専用: true
• scope: 文字列
  タイトル: Scope

  デフォルト値: write

  許可されるスコープ。さらにユーザーの権限を制限します。許可されるスコープ['read', 'write']が指定された、スペースで区切られた単純な文字列である必要があります。
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• token: 文字列
  タイトル: Token

  読取り専用: true
• type: 文字列
  タイトル: Type

  読取り専用: true
• url: 文字列
  タイトル: Url

  読取り専用: true
• user: 整数
  タイトル: User

  読取り専用: true

  トークンの所有者を表すユーザー

{
    "properties":{
        "application":{
            "title":"Application",
            "type":"integer",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "expires":{
            "format":"date-time",
            "readOnly":true,
            "title":"Expires",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"Id",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "refresh_token":{
            "readOnly":true,
            "title":"Refresh token",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scope":{
            "default":"write",
            "description":"Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write'].",
            "title":"Scope",
            "type":"string",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "token":{
            "readOnly":true,
            "title":"Token",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "user":{
            "description":"The user representing the token owner",
            "readOnly":true,
            "title":"User",
            "type":"integer"
        }
    },
    "type":"object"
}

先頭に戻る