OAuth

Validate access token

/v1/oauth/token/validate

Request parameters

{
  "accessToken": "example"
}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{
  "data": {
    "identities": [
      {},
      {}
    ],
    "userId": {},
    "machineId": {},
    "expiresAt": "2007-07-20T14:33:34Z"
  }
}

Authenticate user and return access/refresh token

/v1/oauth/token

Request parameters

{
  "apiKey": "example",
  "secretKey": "example",
  "identity": "example",
  "password": "example"
}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{
  "data": {
    "accessToken": {
      "token": "example",
      "expires": "1983-08-13T23:33:37Z"
    },
    "refreshToken": {
      "token": "example",
      "expires": "1983-08-13T23:33:37Z"
    }
  }
}

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

Revoke the refresh token.

/v1/oauth/token/revoke

Request parameters

{
  "refreshToken": "example",
  "allOfUser": false
}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{}

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

Refresh tokens.

/v1/oauth/token/refresh

Request parameters

{
  "apiKey": "example",
  "secretKey": "example",
  "accessToken": "example",
  "refreshToken": "example"
}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{
  "data": {
    "accessToken": {
      "token": "example",
      "expires": "1983-08-13T23:33:37Z"
    },
    "refreshToken": {
      "token": "example",
      "expires": "1983-08-13T23:33:37Z"
    }
  }
}

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

Get authentication token for machine/client

/v1/oauth/token/machine

Request parameters

{
  "apiKey": "example",
  "secretKey": "example"
}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{
  "data": {
    "token": "example",
    "expires": "1983-08-13T23:33:37Z"
  }
}

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

Forgot password request

/v1/oauth/forgot-password

Request parameters

{
  "identity": "example"
}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{}

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

Reset password

/v1/oauth/reset-password

Request parameters

{
  "resetToken": "example",
  "password": "example"
}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{}

Get permissions

/v1/oauth/permissions

Request parameters

{
  "accessToken": "example"
}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{
  "data": [
    "example"
  ]
}

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

Last modified: 17 August 2024