Memos
User Service

Create User

CreateUser creates a new user.

POST
/api/v1/users

Query Parameters

userId?string

Optional. The resource ID to use for this user. If set, it must equal user.username, follow the UID format, and not consist entirely of digits. Format: ^a-zA-Z0-9?$

validateOnly?boolean

Optional. If set, validate the request but don't actually create the user.

requestId?string

Optional. An idempotency token that can be used to ensure that multiple requests to create a user have the same result.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/users" \  -H "Content-Type: application/json" \  -d '{    "role": "ROLE_UNSPECIFIED",    "username": "string",    "state": "STATE_UNSPECIFIED"  }'
{  "name": "string",  "role": "ROLE_UNSPECIFIED",  "username": "string",  "email": "string",  "displayName": "string",  "avatarUrl": "string",  "description": "string",  "password": "string",  "state": "STATE_UNSPECIFIED",  "createTime": "2019-08-24T14:15:22Z",  "updateTime": "2019-08-24T14:15:22Z"}

Create Personal Access Token

CreatePersonalAccessToken creates a new Personal Access Token for a user. The token value is only returned once upon creation.

Create User Webhook

CreateUserWebhook creates a new webhook for a user.