GET /api/users 200 { "total": 2, "subtotal": 2, "page": 1, "per_page": 20, "search": null, "sort": { "by": null, "order": null }, "results": [ { "firstname": "One", "lastname": "User", "mail": "userone@someware.com", "mail_enabled": true, "admin": false, "auth_source_id": 980190962, "disabled": false, "auth_source_name": "ldap-server", "timezone": null, "locale": null, "last_login_on": "2009-10-12 21:50:04 UTC", "created_at": "2022-03-29 08:47:36 UTC", "updated_at": "2022-03-29 08:47:36 UTC", "id": 980190962, "login": "one", "description": null, "ssh_keys": [], "default_location": null, "locations": [ { "id": 255093256, "name": "Location 1" } ], "default_organization": null, "organizations": [ { "id": 447626438, "name": "Organization 1" } ], "effective_admin": false }, { "firstname": "Scoped", "lastname": "User", "mail": "userscoped@someware.com", "mail_enabled": true, "admin": false, "auth_source_id": 980190962, "disabled": false, "auth_source_name": "ldap-server", "timezone": null, "locale": null, "last_login_on": "2009-10-12 21:50:05 UTC", "created_at": "2022-03-29 08:47:36 UTC", "updated_at": "2022-03-29 08:47:36 UTC", "id": 117925625, "login": "scoped", "description": null, "ssh_keys": [], "default_location": null, "locations": [ { "id": 255093256, "name": "Location 1" } ], "default_organization": null, "organizations": [ { "id": 447626438, "name": "Organization 1" } ], "effective_admin": false } ] }
Param name | Description |
---|---|
auth_source_ldap_id optional |
ID of LDAP authentication source Validations:
|
usergroup_id optional |
ID of user group Validations:
|
role_id optional |
ID of role Validations:
|
location_id optional |
Scope by locations Validations:
|
organization_id optional |
Scope by organizations Validations:
|
search optional |
filter results Validations:
|
order optional |
Sort and order by a searchable field, e.g. ‘ Maruku could not parse this XML/HTML: <field> DESC' Validations:
|
page optional |
Page number, starting at 1 Validations:
|
per_page optional |
Number of results per page to return, ‘all’ to return all results Validations:
|
Field name | Type | Possible values |
---|---|---|
admin | true, false | |
auth_source | string | |
auth_source_type | string | |
description | text | |
disabled | true, false | |
firstname | string | |
id | integer | |
last_login_on | datetime | |
lastname | string | |
location | string | |
location_id | integer | |
login | string | |
string | ||
organization | string | |
organization_id | integer | |
role | string | |
role_id | integer | |
usergroup | string |
GET /api/users/one 200 { "firstname": "One", "lastname": "User", "mail": "userone@someware.com", "mail_enabled": true, "admin": false, "auth_source_id": 980190962, "disabled": false, "auth_source_name": "ldap-server", "timezone": null, "locale": null, "last_login_on": "2009-10-12 21:50:04 UTC", "created_at": "2022-03-29 08:47:36 UTC", "updated_at": "2022-03-29 08:47:36 UTC", "id": 980190962, "login": "one", "description": null, "ssh_keys": [], "default_location": null, "locations": [ { "id": 255093256, "name": "Location 1", "title": "Location 1", "description": null } ], "default_organization": null, "organizations": [ { "id": 447626438, "name": "Organization 1", "title": "Organization 1", "description": null } ], "effective_admin": false, "cached_usergroups": [], "auth_source_ldap": { "id": 980190962, "type": "AuthSourceLdap", "name": "ldap-server" }, "mail_notifications": [], "roles": [ { "name": "Viewer", "id": 5, "description": null, "origin": "foreman" } ], "usergroups": [] }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
GET /api/current_user 401 { "error": { "message": "Unable to authenticate user " } }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
Adds role ‘Default role’ to the user by default
POST /api/users { "user": { "login": "foo", "auth_source_id": 200482051, "password": "123456", "role_ids": [ 1 ], "organization_ids": [ 447626479 ], "location_ids": [ 447626480 ] } } 201 { "firstname": null, "lastname": null, "mail": null, "mail_enabled": true, "admin": false, "auth_source_id": 200482051, "disabled": false, "auth_source_name": "Internal", "timezone": null, "locale": null, "last_login_on": null, "created_at": "2022-03-29 08:47:52 UTC", "updated_at": "2022-03-29 08:47:52 UTC", "id": 988725685, "login": "foo", "description": null, "ssh_keys": [], "default_location": null, "locations": [ { "id": 447626480, "name": "loc247", "title": "loc247", "description": null } ], "default_organization": null, "organizations": [ { "id": 447626479, "name": "org217", "title": "org217", "description": null } ], "effective_admin": false, "cached_usergroups": [], "auth_source_internal": { "id": 200482051, "type": "AuthSourceInternal", "name": "Internal" }, "mail_notifications": [], "roles": [ { "name": "Manager", "id": 1, "description": null, "origin": "foreman" } ], "usergroups": [] }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
user required |
Validations:
|
user[login] required |
Validations:
|
user[firstname] optional , nil allowed |
Validations:
|
user[lastname] optional , nil allowed |
Validations:
|
user[mail] required |
Validations:
|
user[description] optional , nil allowed |
Validations:
|
user[disabled] optional , nil allowed |
Validations:
|
user[admin] optional , nil allowed |
is an admin account Validations:
|
user[password] optional , nil allowed |
Required unless user is in an external authentication source Validations:
|
user[default_location_id] optional , nil allowed |
Validations:
|
user[default_organization_id] optional , nil allowed |
Validations:
|
user[auth_source_id] required |
Validations:
|
user[timezone] optional , nil allowed |
User’s timezone Validations:
|
user[locale] optional , nil allowed |
User’s preferred locale Validations:
|
user[role_ids] optional , nil allowed |
Validations:
|
user[mail_enabled] optional , nil allowed |
Enable user’s email Validations:
|
user[location_ids] optional , nil allowed |
REPLACE locations with given ids Validations:
|
user[organization_ids] optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
Adds role ‘Default role’ to the user if it is not already present. Only another admin can change the admin account attribute.
PUT /api/users/980190962 { "user": { "admin": true } } 200 { "firstname": "One", "lastname": "User", "mail": "userone@someware.com", "mail_enabled": true, "admin": true, "auth_source_id": 980190962, "disabled": false, "auth_source_name": "ldap-server", "timezone": null, "locale": null, "last_login_on": "2009-10-12 21:50:04 UTC", "created_at": "2022-03-29 08:47:36 UTC", "updated_at": "2022-03-29 08:47:50 UTC", "id": 980190962, "login": "one", "description": null, "ssh_keys": [], "default_location": null, "locations": [ { "id": 255093256, "name": "Location 1", "title": "Location 1", "description": null } ], "default_organization": null, "organizations": [ { "id": 447626438, "name": "Organization 1", "title": "Organization 1", "description": null } ], "effective_admin": true, "cached_usergroups": [], "auth_source_ldap": { "id": 980190962, "type": "AuthSourceLdap", "name": "ldap-server" }, "mail_notifications": [], "roles": [ { "name": "Viewer", "id": 5, "description": null, "origin": "foreman" } ], "usergroups": [] }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
user required |
Validations:
|
user[login] optional |
Validations:
|
user[firstname] optional , nil allowed |
Validations:
|
user[lastname] optional , nil allowed |
Validations:
|
user[mail] optional |
Validations:
|
user[description] optional , nil allowed |
Validations:
|
user[disabled] optional , nil allowed |
Validations:
|
user[admin] optional , nil allowed |
is an admin account Validations:
|
user[password] optional , nil allowed |
Required unless user is in an external authentication source Validations:
|
user[default_location_id] optional , nil allowed |
Validations:
|
user[default_organization_id] optional , nil allowed |
Validations:
|
user[auth_source_id] optional |
Validations:
|
user[timezone] optional , nil allowed |
User’s timezone Validations:
|
user[locale] optional , nil allowed |
User’s preferred locale Validations:
|
user[role_ids] optional , nil allowed |
Validations:
|
user[mail_enabled] optional , nil allowed |
Enable user’s email Validations:
|
user[location_ids] optional , nil allowed |
REPLACE locations with given ids Validations:
|
user[organization_ids] optional , nil allowed |
REPLACE organizations with given ids. Validations:
|
user[current_password] optional , nil allowed |
Required when user want to change own password Validations:
|
DELETE /api/users/980190962 { "user": {} } 200 { "id": 980190962, "login": "one", "firstname": "One", "lastname": "User", "mail": "userone@someware.com", "admin": false, "last_login_on": "2009-10-12T21:50:04.000Z", "auth_source_id": 980190962, "created_at": "2022-03-29T08:47:36.982Z", "updated_at": "2022-03-29T08:47:36.982Z", "password_hash": null, "password_salt": null, "locale": null, "avatar_hash": null, "default_organization_id": null, "default_location_id": null, "lower_login": "one", "mail_enabled": true, "timezone": null, "description": null, "disabled": false, "password": null, "name": "One User" }
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|