You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
65 lines
2.2 KiB
65 lines
2.2 KiB
---
|
|
get:
|
|
description: "Retrieve a fresh access token for API access. Depending on the grant type you use, different parameters are required. Client Credentials grant type requires you to send a client secret. Authorization Code grant type requires you to send a code generated by the authorize endpoint. Refresh Token grant type requires you to send your valid refresh token."
|
|
parameters:
|
|
- name: grant_type
|
|
in: query
|
|
description: "One of: client_credentials, authorization_code, refresh_token"
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: client_id
|
|
in: query
|
|
description: Your application client id generated by the Tiki OAuth server.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: client_secret
|
|
in: query
|
|
description: Your application client secret generated by the Tiki OAuth server.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
- name: scope
|
|
in: query
|
|
description: A space delimited list of scopes. Valid with client_credentials or refresh_token grant type.
|
|
schema:
|
|
type: string
|
|
- name: refresh_token
|
|
in: query
|
|
description: Your refresh token. Use to renew an expired access token and get a new refresh token.
|
|
schema:
|
|
type: string
|
|
- name: code
|
|
in: query
|
|
description: Required if authorization_code grant is used. Retrive this code by sending the user to authorize endpoint first.
|
|
schema:
|
|
type: string
|
|
- name: redirect_uri
|
|
in: query
|
|
description: Should be the same redirect uri you used in authorize endpoint.
|
|
schema:
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: access token response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
token_type:
|
|
type: string
|
|
expires_in:
|
|
type: integer
|
|
access_token:
|
|
type: string
|
|
refresh_token:
|
|
type: string
|
|
description: Only sent with authorization_code and refresh_token grant types.
|
|
'403':
|
|
description: forbidden
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: schemas-Error.yaml
|