Validates a token

GET 
/auth/reset/validate

If the token is valid returns the user that owns the token

Responses

200

tokenUserSchema

application/json

Schema

Schema

id integerrequired
The user id
Example: 7
name string
The name of the user
Example: Test McTest
email stringrequired
The email of the user
Example: test@example.com
token stringrequired
A token uniquely identifying a user
Example: user:xyzrandomstring
createdBy stringnullablerequired
A username or email identifying which user created this token
Example: admin@example.com

role

object

required

A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform

id integerrequired

The role id

Example: 9

type stringrequired

A role can either be a global root role (applies to all projects) or a project role

Example: root

name stringrequired

The name of the role

Example: Editor

description string

A more detailed description of the role and what use it's intended for

Example: Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.

project stringnullable

What project the role belongs to

Example: default

Example (from schema)

{
  "id": 7,
  "name": "Test McTest",
  "email": "test@example.com",
  "token": "user:xyzrandomstring",
  "createdBy": "admin@example.com",
  "role": {
    "id": 9,
    "type": "root",
    "name": "Editor",
    "description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
    "project": "default"
  }
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

415

The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ContentTypeerror
message string
A description of what went wrong.
Example: We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ContentTypeerror",
  "message": "We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format."
}

Loading...