4cb8d1f814
* 6113 add tfa generate endpoint * 6113 implement tfa otp check in user settings * 6113 add autfocus for otp field on login form * update package-lock * improve TFA uri with user email * fix vue 3 compatibility * reduce code duplication for enableTFA * Remove unnecessary parameters * Use project name in otp url when available * Update docs/reference/api/system/users.md Co-authored-by: Wendelin Peleska <wendu@pm.me>
13 KiB
pageClass
| pageClass |
|---|
| page-reference |
Users
Directus Users are the individual accounts that let you authenticate into the API and App. Each user belongs to a Role which defines its granular Permissions. Learn more about Users.
The User Object
id uuid
Primary key of the user.
first_name string
First name of the user.
last_name string
Last name of the user.
email string
Email address of the user.
password hash
Password of the user.
location string
Location of the user.
title string
Title of the user.
description string
Description of the user.
tags csv
Tags for the user.
avatar many-to-one
Avatar file. Many-to-one to files.
language string
Language the Admin App is rendered in. See our Crowdin page for all available languages and
translations.
theme string
One of auto, light, dark.
tfa_secret string
When TFA is enabled, this holds the
{
"id": "0bc7b36a-9ba9-4ce0-83f0-0a526f354e07",
"first_name": "Admin",
"last_name": "User",
"email": "admin@example.com",
"password": "**********",
"location": "New York City",
"title": "CTO",
"description": null,
"tags": null,
"avatar": null,
"language": "en-US",
"theme": "auto",
"tfa_secret": null,
"status": "active",
"role": "653925a9-970e-487a-bfc0-ab6c96affcdc",
"token": null,
"last_access": "2021-02-05T10:18:13-05:00",
"last_page": "/settings/roles/653925a9-970e-487a-bfc0-ab6c96affcdc"
}
List Users
List all users that exist in Directus.
Query Parameters
Supports all global query parameters.
Returns
An array of up to limit user objects. If no items are available, data will be an empty array.
REST API
GET /users
SEARCH /users
GraphQL
POST /graphql/system
type Query {
users: [directus_users]
}
Example
query {
users {
first_name
last_name
email
}
}
Retrieve a User
List an existing user by primary key.
REST API
GET /users/:id
Example
GET /users/72a1ce24-4748-47de-a05f-ce9af3033727
GraphQL
POST /graphql/system
type Query {
users_by_id(id: ID!): directus_users
}
Example
query {
users_by_id(id: "72a1ce24-4748-47de-a05f-ce9af3033727") {
first_name
last_name
email
}
}
Retrieve the Current User
Retrieve the currently authenticated user.
Query Parameters
Supports all global query parameters.
Returns
Returns the user object for the currently authenticated user.
REST API
GET /users/me
GraphQL
POST /graphql/system
type Query {
users_me: directus_users
}
Example
query {
users_me {
email
}
}
Create a User
Create a new user
Query Parameters
Supports all global query parameters.
Request Body
A partial user object.
email and password are required.
Returns
Returns the user object for the created user.
REST API
POST /users
Example
// POST /users
{
"email": "another@example.com",
"password": "d1r3ctu5",
"role": "c86c2761-65d3-43c3-897f-6f74ad6a5bd7"
}
GraphQL
POST /graphql/system
type Mutation {
create_users_item(data: create_directus_users_input!): directus_users
}
Example
mutation {
create_users_item(
data: { email: "another@example.com", password: "d1r3ctu5", role: "c86c2761-65d3-43c3-897f-6f74ad6a5bd7" }
) {
email
role
}
}
Create Multiple Users
Create multiple new users
Query Parameters
Supports all global query parameters.
Request Body
An array of partial user objects.
email and password are required.
Returns
Returns the user objects for the created users.
REST API
POST /users
Example
// POST /users
[
{
"email": "admin@example.com",
"password": "p455w0rd",
"role": "c86c2761-65d3-43c3-897f-6f74ad6a5bd7"
},
{
"email": "another@example.com",
"password": "d1r3ctu5",
"role": "c86c2761-65d3-43c3-897f-6f74ad6a5bd7"
}
]
GraphQL
POST /graphql/system
type Mutation {
create_users_items(data: [create_directus_users_input!]!): [directus_users]
}
Example
mutation {
create_users_items(
data: [
{ email: "admin@example.com", password: "p455w0rd", role: "c86c2761-65d3-43c3-897f-6f74ad6a5bd7" }
{ email: "another@example.com", password: "d1r3ctu5", role: "c86c2761-65d3-43c3-897f-6f74ad6a5bd7" }
]
) {
email
role
}
}
Update a User
Update an existing user.
Query Parameters
Supports all global query parameters.
Request Body
A partial user object.
Returns
Returns the user object for the updated user.
REST API
PATCH /users/:id
Example
// PATCH /users/72a1ce24-4748-47de-a05f-ce9af3033727
{
"title": "CTO"
}
GraphQL
POST /graphql/system
type Mutation {
update_users_item(id: ID!, data: update_directus_users_input!): directus_users
}
Example
mutation {
update_users_item(id: "72a1ce24-4748-47de-a05f-ce9af3033727", data: { title: "CTO" }) {
first_name
last_name
}
}
Update Multiple Users
Update multiple existing users.
Query Parameters
Supports all global query parameters.
Request Body
keys Required
Array of primary keys of the users you'd like to update.
data Required
Any of the user object's properties.
Returns
Returns the user objects for the updated users.
REST API
PATCH /users
Example
// PATCH /users
{
"keys": ["72a1ce24-4748-47de-a05f-ce9af3033727", "9c3d75a8-7a5f-41a4-be0a-1488fd974511"],
"data": {
"title": "CTO"
}
}
GraphQL
POST /graphql/system
type Mutation {
update_users_items(ids: [ID!]!, data: update_directus_users_input!): [directus_users]
}
Example
mutation {
update_users_items(
ids: ["72a1ce24-4748-47de-a05f-ce9af3033727", "9c3d75a8-7a5f-41a4-be0a-1488fd974511"]
data: { title: "CTO" }
) {
first_name
last_name
}
}
Delete a User
Delete an existing user.
Returns
Empty body.
REST API
DELETE /users/:id
Example
DELETE /users/72a1ce24-4748-47de-a05f-ce9af3033727
GraphQL
POST /graphql/system
type Mutation {
delete_users_item(id: ID!): delete_one
}
Example
mutation {
delete_users_item(id: "72a1ce24-4748-47de-a05f-ce9af3033727") {
id
}
}
Delete Multiple Users
Delete multiple existing users.
Request Body
An array of user primary keys
Returns
Empty body.
REST API
DELETE /users
Example
// Request
["653925a9-970e-487a-bfc0-ab6c96affcdc", "c86c2761-65d3-43c3-897f-6f74ad6a5bd7"]
GraphQL
POST /graphql/system
type Mutation {
delete_users_items(ids: [ID!]!): delete_many
}
Example
mutation {
delete_users_items(ids: ["72a1ce24-4748-47de-a05f-ce9af3033727", "9c3d75a8-7a5f-41a4-be0a-1488fd974511"]) {
ids
}
}
Invite a new User
Invite a new user by email.
Request Body
email Required
User email to invite.
role Required
Role of the new user.
invite_url
Provide a custom invite url which the link in the email will lead to. The invite token will be passed as a parameter.
Note: You need to configure the
USER_INVITE_URL_ALLOW_LIST environment variable to enable this feature.
Returns
Empty body.
REST API
POST /users/invite
Example
// POST /users/invite
{
"email": "another@example.com",
"role": "c86c2761-65d3-43c3-897f-6f74ad6a5bd7"
}
GraphQL
POST /graphql/system
type Mutation {
users_invite(email: String!, role: String!, invite_url: String): Boolean
}
Example
mutation {
users_invite(email: "another@example.com", role: "c86c2761-65d3-43c3-897f-6f74ad6a5bd7")
}
Accept User Invite
Accept your invite. The invite user endpoint sends the email a link to the Admin App.
This link includes a token, which is then used to activate the invited user.
Request Body
token Required
Accept invite token.
password Required
Password for the user.
Returns
Empty body.
REST API
POST /users/invite/accept
Example
// POST /users/invite/accept
{
"token": "eyJh...KmUk",
"password": "d1r3ctu5"
}
GraphQL
POST /graphql/system
type Mutation {
users_invite_accept(token: String!, password: String!): Boolean
}
Example
mutation {
users_invite_accept(token: "eyJh...KmUk", password: "d1r3ctu5")
}
Generate Two-Factor Authentication Secret
Generates a secret and returns the URL to be used in an authenticator app.
Request Body
password Required
The user's password.
Returns
secret string
OTP secret to be saved in the authenticator app.
otpauth_url string
otpauth:// formatted URL. Can be rendered as QR code and used in most authenticator apps.
REST API
POST /users/me/tfa/generate
Example
// POST /users/me/tfa/generate
{
"password": "d1r3ctu5"
}
GraphQL
POST /graphql/system
type Mutation {
users_me_tfa_generate(password: String!): users_me_tfa_generate_data
}
Example
mutation {
users_me_tfa_generate(password: "d1r3ctu5") {
secret
otpauth_url
}
}
Enable Two-Factor Authentication
Adds a TFA secret to the user account.
Request Body
secret Required
The TFA secret from tfa/generate.
otp Required
OTP generated with the secret, to recheck if the user has a correct TFA setup
Returns
Empty response.
REST API
POST /users/me/tfa/enable
Example
// POST /users/me/tfa/enable
{
"otp": "123456",
"secret": "3CtiutsNBmY3szHE"
}
GraphQL
POST /graphql/system
type Mutation {
users_me_tfa_enable(otp: String!, secret: String!): Boolean
}
Example
mutation {
users_me_tfa_enable(otp: "123456", secret: "3CtiutsNBmY3szHE")
}
Disable Two-Factor Authentication
Disables two-factor authentication by removing the OTP secret from the user.
Request Body
otp Required
One-time password generated by the authenticator app.
Returns
Empty response.
REST API
POST /users/me/tfa/disable
Example
// POST /users/me/tfa/disable
{
"otp": "859014"
}
GraphQL
POST /graphql/system
type Mutation {
users_me_tfa_disable(otp: String!): Boolean
}
Example
mutation {
users_me_tfa_disable(otp: "591763")
}