API: Users
Actions
| Link | Description | Condition |
|---|---|---|
| lock | Restrict the user from logging in and performing any actions | not locked; Permission: Administrator |
| show | Link to the OpenProject user page (HTML) | |
| unlock | Allow a locked user to login and act again | locked; Permission: Administrator |
| updateImmediately | Updates the user’s attributes. | Permission: Administrator, manage_user global permission |
| delete | Permanently remove a user from the instance | Permission: Administrator, self-delete |
Linked Properties
| Link | Description | Type | Constraints | Supported operations | Condition |
|---|---|---|---|---|---|
| self | This user | User | not null | READ | |
| auth_source | Link to the user’s auth source (endpoint not yet implemented) | LdapAuthSource | READ / WRITE | Permission: Administrator | |
| members | Link to collection of all the user’s memberships. The list will only include the memberships in projects in which the requesting user has the necessary permissions. | MemberCollection | READ | Permission: view members or manage members in any project |
Depending on custom fields defined for users, additional links might exist.
Local Properties
| Property | Description | Type | Constraints | Supported operations | Condition |
|---|---|---|---|---|---|
| id | User’s id | Integer | x > 0 | READ | |
| login | User’s login name | String | unique, 256 max length | READ / WRITE | Permission: Administrator, manage_user global permission |
| firstName | User’s first name | String | 30 max length | READ / WRITE | Permission: Administrator, manage_user global permission |
| lastName | User’s last name | String | 30 max length | READ / WRITE | Permission: Administrator, manage_user global permission |
| name | User’s full name, formatting depends on instance settings | String | READ | ||
| User’s email address | String | unique, 60 max length | READ / WRITE | E-Mail address not hidden, Permission: Administrator, manage_user global permission | |
| admin | Flag indicating whether or not the user is an admin | Boolean | in: [true, false] | READ / WRITE | Permission: Administrator |
| avatar | URL to user’s avatar | Url | READ | ||
| status | The current activation status of the user (see below) | String | in: [“active”, “registered”, “locked”, “invited”] | READ | |
| language | User’s language | String | ISO 639-1 | READ / WRITE | Permission: Administrator, manage_user global permission |
| password | User’s password for the default password authentication | String | WRITE | Permission: Administrator | |
| identity_url | User’s identity_url for OmniAuth authentication | String | READ / WRITE | Permission: Administrator | |
| createdAt | Time of creation | DateTime | READ | ||
| updatedAt | Time of the most recent change to the user | DateTime | READ |
Depending on custom fields defined for users, additional properties might exist.
The status of a user can be one of:
-
active- the user can log in with the account right away -
invited- the user is invited and is pending registration
If the user’s status is set to active during creation a means of authentication has to be provided which is one of the following:
-
password- The password with which the user logs in. -
auth_source- Link to an LDAP auth source. -
identity_url- The identity URL of an OmniAuth authentication provider.
If all of these are missing the creation will fail with an “missing password” error.
The language is limited to those activated in the system.
Due to data privacy, the user’s properties are limited to reveal as little about the user as possible. Thus login, firstName, lastName, language, createdAt and updatedAt are hidden for all users except for admins or the user themselves.
Please note that custom fields are not yet supported by the api although the backend supports them.
Methods
List users
Lists users. Only administrators or users with any of the following can access this resource:
manage_membersmanage_usershare_work_packages
offset
integer
optional query
Page number inside the requested collection.
Default:1
Example:25
pageSize
integer
optional query
Number of elements to display per page.
Example:25
filters
string
optional query
JSON specifying filter conditions. Accepts the same format as returned by the queries endpoint. Currently supported filters are:
-
status: Status the user has
-
group: Name of the group in which to-be-listed users are members.
-
name: Filter users in whose first or last names, or email addresses the given string occurs.
-
login: User’s login
Example:[{ "status": { "operator": "=", "values": ["invited"] } }, { "group": { "operator": "=", "values": ["1"] } }, { "name": { "operator": "=", "values": ["h.wurst@openproject.com"] } }]
sortBy
string
optional query
JSON specifying sort criteria. Accepts the same format as returned by the queries endpoint.
Example:[["status", "asc"]]
select
string
optional query
Comma separated list of properties to include.
Example:total,elements/name,elements/self,self
200
OK
UserCollectionModel{
"allOf": [
{
"$ref": "#/components/schemas/CollectionModel"
},
{
"type": "object",
"required": [
"_links",
"_embedded"
],
"properties": {
"_links": {
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "This user collection\n\n**Resource**: Collection"
}
]
}
}
},
"_embedded": {
"type": "object",
"required": [
"elements"
],
"properties": {
"elements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserModel"
}
}
}
}
}
}
],
"example": {
"_type": "Collection",
"total": 2,
"count": 2,
"_links": {
"self": {
"href": "/api/v3/users"
}
},
"_embedded": {
"elements": [
{
"_hint": "User resource shortened for brevity",
"_type": "User",
"id": 1337
},
{
"_hint": "User resource shortened for brevity",
"_type": "User",
"id": 1338
}
]
}
}
}
400
Occurs when the client did not send a valid JSON object in the request body.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:InvalidRequestBody",
"message": "The request body was not a single JSON object."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
403
Returned if the client does not have sufficient permissions.
Required permission: Administrator or any of: ‘manage_members’, ‘manage_user’, ‘share_work_packages’.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
"message": "You are not allowed to list users."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
Create user
Creates a new user. Only administrators and users with manage_user global permission are allowed to do so. When calling this endpoint the client provides a single object, containing at least the properties and links that are required, in the body.
Valid values for status:
-
“active” - In this case a password has to be provided in addition to the other attributes.
-
“invited” - In this case nothing but the email address is required. The rest is optional. An invitation will be sent to the user.
No parameters
{
"login": "j.sheppard",
"password": "idestroyedsouvereign",
"firstName": "John",
"lastName": "Sheppard",
"email": "shep@mail.com",
"admin": true,
"status": "active",
"language": "en"
}
{
"admin": {
"type": "boolean"
},
"email": {
"type": "string",
"maxLength": 60
},
"login": {
"type": "string",
"maxLength": 256
},
"password": {
"type": "string",
"description": "The users password.\n\n*Conditions:*\n\nOnly writable on creation, not on update."
},
"firstName": {
"type": "string",
"maxLength": 30
},
"lastName": {
"type": "string",
"maxLength": 30
},
"status": {
"type": "string",
"description": "The current activation status of the user.\n\n*Conditions:*\n\nOnly writable on creation, not on update."
},
"language": {
"type": "string"
}
}
201
Created
UserModel{
"allOf": [
{
"$ref": "#/components/schemas/PrincipalModel"
},
{
"type": "object",
"required": [
"_type",
"avatar"
],
"properties": {
"_type": {
"type": "string",
"enum": [
"User"
]
},
"avatar": {
"type": "string",
"format": "uri",
"description": "URL to user's avatar"
},
"login": {
"type": "string",
"description": "The user's login name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 256
},
"firstName": {
"type": "string",
"description": "The user's first name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 30
},
"lastName": {
"type": "string",
"description": "The user's last name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 30
},
"email": {
"type": "string",
"description": "The user's email address\n\n# Conditions\n\n- E-Mail address not hidden\n- User is not a new record\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 60
},
"admin": {
"type": "boolean",
"description": "Flag indicating whether or not the user is an admin\n\n# Conditions\n\n- `admin`"
},
"status": {
"type": "string",
"description": "The current activation status of the user.\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"language": {
"type": "string",
"description": "User's language | ISO 639-1 format\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"identityUrl": {
"type": [
"string",
"null"
],
"description": "User's identity_url for OmniAuth authentication.\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Time of creation"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Time of the most recent change to the user"
},
"_links": {
"type": "object",
"properties": {
"showUser": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "A relative path to show the user in the web application.\n\n# Condition\n\n- User is not a new record\n- User is not `locked`"
}
]
},
"updateImmediately": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "A link to update the user resource.\n\n# Conditions\n\n- `admin`"
}
]
},
"lock": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Restrict the user from logging in and performing any actions.\n\n# Conditions\n\n- User is not locked\n- `admin`"
}
]
},
"unlock": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Allow a locked user to login and act again.\n\n# Conditions\n\n- User is not locked\n- `admin`"
}
]
},
"delete": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Permanently remove a user from the instance\n\n# Conditions\n\neither:\n - `admin`\n - Setting `users_deletable_by_admin` is set\nor:\n - User is self\n - Setting `users_deletable_by_self` is set"
}
]
},
"authSource": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Permanently remove a user from the instance\n\n# Conditions\n\n- LDAP authentication configured\n- `admin`"
}
]
}
}
}
}
}
]
}
400
Occurs when the client did not send a valid JSON object in the request body.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:InvalidRequestBody",
"message": "The request body was not a single JSON object."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
403
Returned if the client does not have sufficient permissions.
Required permission: Administrator
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
"message": "You are not allowed to create new users."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
406
415
Occurs when the client sends an unsupported Content-Type header.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:TypeNotSupported",
"message": "Expected CONTENT-TYPE to be (expected value) but got (actual value)."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
422
Returned if:
- a constraint for a property was violated (
PropertyConstraintViolation)
{
"_embedded": {
"details": {
"attribute": "email"
}
},
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation",
"message": "The email address is already taken."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
View user schema
The schema response use two exemplary custom fields that extend the schema response. Depending on your instance and custom field configuration, the response will look somewhat different.
No parameters
200
OK
{
"_dependencies": [
],
"_links": {
"self": {
"href": "/api/v3/users/schema"
}
},
"_type": "Schema",
"admin": {
"hasDefault": false,
"name": "Administrator",
"options": {
},
"required": false,
"type": "Boolean",
"writable": true
},
"avatar": {
"hasDefault": false,
"name": "Avatar",
"options": {
},
"required": false,
"type": "String",
"writable": false
},
"createdAt": {
"hasDefault": false,
"name": "Created on",
"options": {
},
"required": true,
"type": "DateTime",
"writable": false
},
"customField1": {
"hasDefault": false,
"name": "User String CF",
"required": false,
"type": "String",
"writable": true
},
"customField2": {
"hasDefault": false,
"location": "_links",
"name": "User List cf",
"required": false,
"type": "CustomOption",
"writable": true
},
"firstName": {
"hasDefault": false,
"maxLength": 255,
"minLength": 1,
"name": "First name",
"options": {
},
"required": true,
"type": "String",
"writable": false
},
"id": {
"hasDefault": false,
"name": "ID",
"options": {
},
"required": true,
"type": "Integer",
"writable": false
},
"identityUrl": {
"hasDefault": false,
"name": "Identity url",
"options": {
},
"required": false,
"type": "String",
"writable": true
},
"language": {
"hasDefault": false,
"name": "Language",
"options": {
},
"required": false,
"type": "String",
"writable": true
},
"lastName": {
"hasDefault": false,
"maxLength": 255,
"minLength": 1,
"name": "Last name",
"options": {
},
"required": true,
"type": "String",
"writable": false
},
"login": {
"hasDefault": false,
"maxLength": 255,
"minLength": 1,
"name": "Username",
"options": {
},
"required": true,
"type": "String",
"writable": true
},
"mail": {
"hasDefault": false,
"maxLength": 255,
"minLength": 1,
"name": "Email",
"options": {
},
"required": true,
"type": "String",
"writable": true
},
"password": {
"hasDefault": false,
"name": "Password",
"options": {
},
"required": false,
"type": "Password",
"writable": false
},
"status": {
"hasDefault": false,
"name": "Status",
"options": {
},
"required": false,
"type": "String",
"writable": true
},
"updatedAt": {
"hasDefault": false,
"name": "Updated on",
"options": {
},
"required": true,
"type": "DateTime",
"writable": false
}
}
View_user_schemaModel{
"type": "object",
"example": {
"_type": "Schema",
"_dependencies": [
],
"id": {
"type": "Integer",
"name": "ID",
"required": true,
"hasDefault": false,
"writable": false,
"options": {
}
},
"login": {
"type": "String",
"name": "Username",
"required": true,
"hasDefault": false,
"writable": true,
"minLength": 1,
"maxLength": 255,
"options": {
}
},
"admin": {
"type": "Boolean",
"name": "Administrator",
"required": false,
"hasDefault": false,
"writable": true,
"options": {
}
},
"mail": {
"type": "String",
"name": "Email",
"required": true,
"hasDefault": false,
"writable": true,
"minLength": 1,
"maxLength": 255,
"options": {
}
},
"firstName": {
"type": "String",
"name": "First name",
"required": true,
"hasDefault": false,
"writable": false,
"minLength": 1,
"maxLength": 255,
"options": {
}
},
"lastName": {
"type": "String",
"name": "Last name",
"required": true,
"hasDefault": false,
"writable": false,
"minLength": 1,
"maxLength": 255,
"options": {
}
},
"avatar": {
"type": "String",
"name": "Avatar",
"required": false,
"hasDefault": false,
"writable": false,
"options": {
}
},
"status": {
"type": "String",
"name": "Status",
"required": false,
"hasDefault": false,
"writable": true,
"options": {
}
},
"identityUrl": {
"type": "String",
"name": "Identity url",
"required": false,
"hasDefault": false,
"writable": true,
"options": {
}
},
"language": {
"type": "String",
"name": "Language",
"required": false,
"hasDefault": false,
"writable": true,
"options": {
}
},
"password": {
"type": "Password",
"name": "Password",
"required": false,
"hasDefault": false,
"writable": false,
"options": {
}
},
"createdAt": {
"type": "DateTime",
"name": "Created on",
"required": true,
"hasDefault": false,
"writable": false,
"options": {
}
},
"updatedAt": {
"type": "DateTime",
"name": "Updated on",
"required": true,
"hasDefault": false,
"writable": false,
"options": {
}
},
"customField1": {
"type": "String",
"name": "User String CF",
"required": false,
"hasDefault": false,
"writable": true
},
"customField2": {
"type": "CustomOption",
"name": "User List cf",
"required": false,
"hasDefault": false,
"writable": true,
"location": "_links"
},
"_links": {
"self": {
"href": "/api/v3/users/schema"
}
}
}
}
View user
id
string
required path
User id. Use me to reference current user, if any.
Example:1
200
OK
{
"_type": "User",
"id": 14,
"name": "Mara Jade",
"createdAt": "2022-04-04T08:07:22.910Z",
"updatedAt": "2024-02-09T09:01:17.382Z",
"login": "member",
"admin": false,
"firstName": "Mara",
"lastName": "Jade",
"email": "m.jade@empire.org",
"avatar": "https://secure.gravatar.com/avatar/17dd23570f3bd129d06db9b48b7a41b8?default=404&secure=true",
"status": "active",
"identityUrl": null,
"language": "en",
"_links": {
"self": {
"href": "/api/v3/users/14",
"title": "Mara Jade"
},
"memberships": {
"href": "/api/v3/memberships?filters=%5B%7B%22principal%22%3A%7B%22operator%22%3A%22%3D%22%2C%22values%22%3A%5B%2214%22%5D%7D%7D%5D",
"title": "Memberships"
},
"showUser": {
"href": "/users/14",
"type": "text/html"
},
"updateImmediately": {
"href": "/api/v3/users/14",
"title": "Update member",
"method": "patch"
},
"lock": {
"href": "/api/v3/users/14/lock",
"title": "Set lock on member",
"method": "post"
},
"delete": {
"href": "/api/v3/users/14",
"title": "Delete member",
"method": "delete"
}
}
}
UserModel{
"allOf": [
{
"$ref": "#/components/schemas/PrincipalModel"
},
{
"type": "object",
"required": [
"_type",
"avatar"
],
"properties": {
"_type": {
"type": "string",
"enum": [
"User"
]
},
"avatar": {
"type": "string",
"format": "uri",
"description": "URL to user's avatar"
},
"login": {
"type": "string",
"description": "The user's login name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 256
},
"firstName": {
"type": "string",
"description": "The user's first name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 30
},
"lastName": {
"type": "string",
"description": "The user's last name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 30
},
"email": {
"type": "string",
"description": "The user's email address\n\n# Conditions\n\n- E-Mail address not hidden\n- User is not a new record\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 60
},
"admin": {
"type": "boolean",
"description": "Flag indicating whether or not the user is an admin\n\n# Conditions\n\n- `admin`"
},
"status": {
"type": "string",
"description": "The current activation status of the user.\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"language": {
"type": "string",
"description": "User's language | ISO 639-1 format\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"identityUrl": {
"type": [
"string",
"null"
],
"description": "User's identity_url for OmniAuth authentication.\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Time of creation"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Time of the most recent change to the user"
},
"_links": {
"type": "object",
"properties": {
"showUser": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "A relative path to show the user in the web application.\n\n# Condition\n\n- User is not a new record\n- User is not `locked`"
}
]
},
"updateImmediately": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "A link to update the user resource.\n\n# Conditions\n\n- `admin`"
}
]
},
"lock": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Restrict the user from logging in and performing any actions.\n\n# Conditions\n\n- User is not locked\n- `admin`"
}
]
},
"unlock": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Allow a locked user to login and act again.\n\n# Conditions\n\n- User is not locked\n- `admin`"
}
]
},
"delete": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Permanently remove a user from the instance\n\n# Conditions\n\neither:\n - `admin`\n - Setting `users_deletable_by_admin` is set\nor:\n - User is self\n - Setting `users_deletable_by_self` is set"
}
]
},
"authSource": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Permanently remove a user from the instance\n\n# Conditions\n\n- LDAP authentication configured\n- `admin`"
}
]
}
}
}
}
}
]
}
404
Returned if the user does not exist or if the API user does not have permission to view them.
Required permission The user needs to be locked in if the installation is configured to prevent anonymous access
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
"message": "The specified user does not exist or you do not have permission to view them."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
Update user
Updates the user’s writable attributes. When calling this endpoint the client provides a single object, containing at least the properties and links that are required, in the body.
id
integer
required path
User id
Example:1
{
"login": "j.sheppard",
"password": "idestroyedsouvereign",
"firstName": "John",
"lastName": "Sheppard",
"email": "shep@mail.com",
"admin": true,
"status": "active",
"language": "en"
}
{
"admin": {
"type": "boolean"
},
"email": {
"type": "string",
"maxLength": 60
},
"login": {
"type": "string",
"maxLength": 256
},
"password": {
"type": "string",
"description": "The users password.\n\n*Conditions:*\n\nOnly writable on creation, not on update."
},
"firstName": {
"type": "string",
"maxLength": 30
},
"lastName": {
"type": "string",
"maxLength": 30
},
"status": {
"type": "string",
"description": "The current activation status of the user.\n\n*Conditions:*\n\nOnly writable on creation, not on update."
},
"language": {
"type": "string"
}
}
200
OK
UserModel{
"allOf": [
{
"$ref": "#/components/schemas/PrincipalModel"
},
{
"type": "object",
"required": [
"_type",
"avatar"
],
"properties": {
"_type": {
"type": "string",
"enum": [
"User"
]
},
"avatar": {
"type": "string",
"format": "uri",
"description": "URL to user's avatar"
},
"login": {
"type": "string",
"description": "The user's login name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 256
},
"firstName": {
"type": "string",
"description": "The user's first name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 30
},
"lastName": {
"type": "string",
"description": "The user's last name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 30
},
"email": {
"type": "string",
"description": "The user's email address\n\n# Conditions\n\n- E-Mail address not hidden\n- User is not a new record\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 60
},
"admin": {
"type": "boolean",
"description": "Flag indicating whether or not the user is an admin\n\n# Conditions\n\n- `admin`"
},
"status": {
"type": "string",
"description": "The current activation status of the user.\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"language": {
"type": "string",
"description": "User's language | ISO 639-1 format\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"identityUrl": {
"type": [
"string",
"null"
],
"description": "User's identity_url for OmniAuth authentication.\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Time of creation"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Time of the most recent change to the user"
},
"_links": {
"type": "object",
"properties": {
"showUser": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "A relative path to show the user in the web application.\n\n# Condition\n\n- User is not a new record\n- User is not `locked`"
}
]
},
"updateImmediately": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "A link to update the user resource.\n\n# Conditions\n\n- `admin`"
}
]
},
"lock": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Restrict the user from logging in and performing any actions.\n\n# Conditions\n\n- User is not locked\n- `admin`"
}
]
},
"unlock": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Allow a locked user to login and act again.\n\n# Conditions\n\n- User is not locked\n- `admin`"
}
]
},
"delete": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Permanently remove a user from the instance\n\n# Conditions\n\neither:\n - `admin`\n - Setting `users_deletable_by_admin` is set\nor:\n - User is self\n - Setting `users_deletable_by_self` is set"
}
]
},
"authSource": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Permanently remove a user from the instance\n\n# Conditions\n\n- LDAP authentication configured\n- `admin`"
}
]
}
}
}
}
}
]
}
400
Occurs when the client did not send a valid JSON object in the request body.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:InvalidRequestBody",
"message": "The request body was not a single JSON object."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
403
Returned if the client does not have sufficient permissions.
Required permission: Administrators, manage_user global permission
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
"message": "You are not allowed to update the account of this user."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
404
Returned if the user does not exist or if the API user does not have the necessary permissions to update it.
Required permission: Administrators only (exception: users may update their own accounts)
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
"message": "The specified user does not exist or you do not have permission to view them."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
406
415
Occurs when the client sends an unsupported Content-Type header.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:TypeNotSupported",
"message": "Expected CONTENT-TYPE to be (expected value) but got (actual value)."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
422
Returned if:
-
the client tries to modify a read-only property (
PropertyIsReadOnly) -
a constraint for a property was violated (
PropertyConstraintViolation)
{
"_embedded": {
"details": {
"attribute": "email"
}
},
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation",
"message": "The email address is already taken."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
Delete user
Permanently deletes the specified user account.
id
integer
required path
User id
Example:1
202
Returned if the account was deleted successfully.
Note that the response body is empty as of now. In future versions of the API a body might be returned, indicating the progress of deletion.
403
Returned if the client does not have sufficient permissions or if deletion of users was disabled in the instance wide settings.
Required permission: Administrators only (exception: users might be able to delete their own accounts)
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
"message": "You are not allowed to delete the account of this user."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
404
Returned if the user does not exist.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
"message": "The specified user does not exist."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
User update form
id
integer
required path
User id
Example:1
200
OK
400
Occurs when the client did not send a valid JSON object in the request body.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:InvalidRequestBody",
"message": "The request body was not a single JSON object."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
403
Returned if the client does not have sufficient permissions.
Required permission: manage_user global permission
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
"message": "You are not authorized to access this resource."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
404
Returned if the request user can not be found.
Note: A client without sufficient permissions shall not be able to test for the existence of a membership. That’s why a 404 is returned here, even if a 403 might be more appropriate.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
"message": "The requested resource could not be found."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
406
415
Occurs when the client sends an unsupported Content-Type header.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:TypeNotSupported",
"message": "Expected CONTENT-TYPE to be (expected value) but got (actual value)."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
Lock user
id
integer
required path
User id
Example:1
200
OK
UserModel{
"allOf": [
{
"$ref": "#/components/schemas/PrincipalModel"
},
{
"type": "object",
"required": [
"_type",
"avatar"
],
"properties": {
"_type": {
"type": "string",
"enum": [
"User"
]
},
"avatar": {
"type": "string",
"format": "uri",
"description": "URL to user's avatar"
},
"login": {
"type": "string",
"description": "The user's login name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 256
},
"firstName": {
"type": "string",
"description": "The user's first name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 30
},
"lastName": {
"type": "string",
"description": "The user's last name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 30
},
"email": {
"type": "string",
"description": "The user's email address\n\n# Conditions\n\n- E-Mail address not hidden\n- User is not a new record\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 60
},
"admin": {
"type": "boolean",
"description": "Flag indicating whether or not the user is an admin\n\n# Conditions\n\n- `admin`"
},
"status": {
"type": "string",
"description": "The current activation status of the user.\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"language": {
"type": "string",
"description": "User's language | ISO 639-1 format\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"identityUrl": {
"type": [
"string",
"null"
],
"description": "User's identity_url for OmniAuth authentication.\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Time of creation"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Time of the most recent change to the user"
},
"_links": {
"type": "object",
"properties": {
"showUser": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "A relative path to show the user in the web application.\n\n# Condition\n\n- User is not a new record\n- User is not `locked`"
}
]
},
"updateImmediately": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "A link to update the user resource.\n\n# Conditions\n\n- `admin`"
}
]
},
"lock": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Restrict the user from logging in and performing any actions.\n\n# Conditions\n\n- User is not locked\n- `admin`"
}
]
},
"unlock": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Allow a locked user to login and act again.\n\n# Conditions\n\n- User is not locked\n- `admin`"
}
]
},
"delete": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Permanently remove a user from the instance\n\n# Conditions\n\neither:\n - `admin`\n - Setting `users_deletable_by_admin` is set\nor:\n - User is self\n - Setting `users_deletable_by_self` is set"
}
]
},
"authSource": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Permanently remove a user from the instance\n\n# Conditions\n\n- LDAP authentication configured\n- `admin`"
}
]
}
}
}
}
}
]
}
400
Returned if the client tries to lock a user account whose current status does not allow this transition.
Required permission: Administrators only
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:InvalidUserStatusTransition",
"message": "The current user account status does not allow this operation."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
403
Returned if the client does not have sufficient permissions for locking a user.
Required permission: Administrators only
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
"message": "You are not allowed to lock the account of this user."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
404
Returned if the user does not exist.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
"message": "The specified user does not exist."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
406
415
Occurs when the client sends an unsupported Content-Type header.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:TypeNotSupported",
"message": "Expected CONTENT-TYPE to be (expected value) but got (actual value)."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
Unlock user
id
integer
required path
User id
Example:1
200
OK
UserModel{
"allOf": [
{
"$ref": "#/components/schemas/PrincipalModel"
},
{
"type": "object",
"required": [
"_type",
"avatar"
],
"properties": {
"_type": {
"type": "string",
"enum": [
"User"
]
},
"avatar": {
"type": "string",
"format": "uri",
"description": "URL to user's avatar"
},
"login": {
"type": "string",
"description": "The user's login name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 256
},
"firstName": {
"type": "string",
"description": "The user's first name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 30
},
"lastName": {
"type": "string",
"description": "The user's last name\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 30
},
"email": {
"type": "string",
"description": "The user's email address\n\n# Conditions\n\n- E-Mail address not hidden\n- User is not a new record\n- User is self, or `create_user` or `manage_user` permission globally",
"maxLength": 60
},
"admin": {
"type": "boolean",
"description": "Flag indicating whether or not the user is an admin\n\n# Conditions\n\n- `admin`"
},
"status": {
"type": "string",
"description": "The current activation status of the user.\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"language": {
"type": "string",
"description": "User's language | ISO 639-1 format\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"identityUrl": {
"type": [
"string",
"null"
],
"description": "User's identity_url for OmniAuth authentication.\n\n# Conditions\n\n- User is self, or `create_user` or `manage_user` permission globally"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Time of creation"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Time of the most recent change to the user"
},
"_links": {
"type": "object",
"properties": {
"showUser": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "A relative path to show the user in the web application.\n\n# Condition\n\n- User is not a new record\n- User is not `locked`"
}
]
},
"updateImmediately": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "A link to update the user resource.\n\n# Conditions\n\n- `admin`"
}
]
},
"lock": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Restrict the user from logging in and performing any actions.\n\n# Conditions\n\n- User is not locked\n- `admin`"
}
]
},
"unlock": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Allow a locked user to login and act again.\n\n# Conditions\n\n- User is not locked\n- `admin`"
}
]
},
"delete": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Permanently remove a user from the instance\n\n# Conditions\n\neither:\n - `admin`\n - Setting `users_deletable_by_admin` is set\nor:\n - User is self\n - Setting `users_deletable_by_self` is set"
}
]
},
"authSource": {
"allOf": [
{
"$ref": "#/components/schemas/Link"
},
{
"description": "Permanently remove a user from the instance\n\n# Conditions\n\n- LDAP authentication configured\n- `admin`"
}
]
}
}
}
}
}
]
}
400
Returned if the client tries to unlock a user account whose current status does not allow this transition.
Required permission: Administrators only
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:InvalidUserStatusTransition",
"message": "The current user account status does not allow this operation."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
403
Returned if the client does not have sufficient permissions for unlocking a user.
Required permission: Administrators only
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
"message": "You are not allowed to unlock the account of this user."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
404
Returned if the user does not exist.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
"message": "The specified user does not exist."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
406
415
Occurs when the client sends an unsupported Content-Type header.
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:TypeNotSupported",
"message": "Expected CONTENT-TYPE to be (expected value) but got (actual value)."
}
ErrorResponse{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
],
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
}
}
}
}
},
"_type": {
"type": "string",
"enum": [
"Error"
]
},
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
},
"message": {
"type": "string",
"example": "Project can't be blank."
}
}
}
