Skip to content

Commit

Permalink
#22078 API design (#22526)
Browse files Browse the repository at this point in the history 
For #22078.
  • Loading branch information
@rachaelshaw
rachaelshaw authored Oct 1, 2024
1 parent 42dc90b commit 3690a0f
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/REST API/rest-api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10801,6 +10801,7 @@ None.
"force_password_reset": false,
"gravatar_url": "",
"sso_enabled": false,
"two_factor_authentication_enabled": false,
"global_role": null,
"api_only": false,
"teams": [
Expand Down Expand Up @@ -10893,6 +10894,7 @@ Creates a user account after an invited user provides registration information a
"force_password_reset": false,
"gravatar_url": "",
"sso_enabled": false,
"two_factor_authentication_enabled": false,
"global_role": "admin",
"teams": []
}
Expand Down Expand Up @@ -10964,6 +10966,7 @@ By default, the user will be forced to reset its password upon first login.
| name | string | body | **Required**. The user's full name or nickname. |
| password | string | body | The user's password (required for non-SSO users). |
| sso_enabled | boolean | body | Whether or not SSO is enabled for the user. |
| two_factor_authentication_enabled | boolean | body | Whether or not email two-factor authentication is enabled for the user. |
| api_only | boolean | body | User is an "API-only" user (cannot use web UI) if true. |
| global_role | string | body | The role assigned to the user. In Fleet 4.0.0, 3 user roles were introduced (`admin`, `maintainer`, and `observer`). In Fleet 4.30.0 and 4.31.0, the `observer_plus` and `gitops` roles were introduced respectively. If `global_role` is specified, `teams` cannot be specified. For more information, see [manage access](https://fleetdm.com/docs/using-fleet/manage-access). |
| admin_forced_password_reset | boolean | body | Sets whether the user will be forced to reset its password upon first login (default=true) |
Expand Down Expand Up @@ -11010,6 +11013,7 @@ By default, the user will be forced to reset its password upon first login.
"force_password_reset": false,
"gravatar_url": "",
"sso_enabled": false,
"two_factor_authentication_enabled": false,
"api_only": true,
"global_role": null,
"teams": [
Expand Down Expand Up @@ -11084,6 +11088,7 @@ Returns all information about a specific user.
"force_password_reset": false,
"gravatar_url": "",
"sso_enabled": false,
"two_factor_authentication_enabled": false,
"global_role": "admin",
"api_only": false,
"teams": []
Expand Down Expand Up @@ -11120,6 +11125,7 @@ Returns all information about a specific user.
| position | string | body | The user's position. |
| email | string | body | The user's email. |
| sso_enabled | boolean | body | Whether or not SSO is enabled for the user. |
| two_factor_authentication_enabled | boolean | body | Whether or not email two-factor authentication is enabled for the user. |
| api_only | boolean | body | User is an "API-only" user (cannot use web UI) if true. |
| password | string | body | The user's current password, required to change the user's own email or password (not required for an admin to modify another user). |
| new_password| string | body | The user's new password. |
Expand Down Expand Up @@ -11155,6 +11161,7 @@ Returns all information about a specific user.
"force_password_reset": false,
"gravatar_url": "",
"sso_enabled": false,
"two_factor_authentication_enabled": false,
"api_only": false,
"teams": []
}
Expand Down Expand Up @@ -11198,6 +11205,7 @@ Returns all information about a specific user.
"force_password_reset": false,
"gravatar_url": "",
"sso_enabled": false,
"two_factor_authentication_enabled": false,
"global_role": "admin",
"teams": [
{
Expand Down Expand Up @@ -11274,6 +11282,7 @@ The selected user is logged out of Fleet and required to reset their password du
"force_password_reset": true,
"gravatar_url": "",
"sso_enabled": false,
"two_factor_authentication_enabled": false,
"global_role": "observer",
"teams": []
}
Expand Down

0 comments on commit 3690a0f

Please sign in to comment.