Jump to

• Request
• Response

Create an Access Token for a User

post

/api/v2/users/{id}/personal_tokens/

Make a POST request to this resource with the following access token fields to create a new access token associated with this user.

• description: Optional description of this access token. (string, default="")

• scope: Allowed scopes, further restricts user's permissions. Must be a simple space-separated string with allowed scopes ['read', 'write']. (string, default="write")

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Body ()

Root Schema : UserPersonalToken

Type: object

Show Source

• application: integer
  Title: Application

  Read Only: true
• 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
  Title: Related

  Read Only: true
• 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

{
    "properties":{
        "application":{
            "readOnly":true,
            "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"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Body ()

Root Schema : UserPersonalToken

Type: object

Show Source

• application: integer
  Title: Application

  Read Only: true
• 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
  Title: Related

  Read Only: true
• 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

{
    "properties":{
        "application":{
            "readOnly":true,
            "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"
}

Back to Top