User Management

User Management APIs create and update user accounts, attach a user to a service provider or location, and handle sign-in and password reset.

How a user moves through these APIs

Onboarding needs an email. Use User provisioning when the user does not have one yet.

Endpoints

Endpoint	What it does
POST /fieldservicegateway/usermanagement/v3/onboarding	Creates a user in one call, including profile, roles, and service provider or location. Updates the user when the account already exists.
POST /fieldservicegateway/usermanagement/v3/user-provisioning	Creates a user when an email may not be available.
PUT /fieldservicegateway/usermanagement/v3/user	Updates a user's name, contact, address, or profile picture.
POST /fieldservicegateway/usermanagement/v3/user/search	Returns a page of users.
POST /fieldservicegateway/usermanagement/v3/user/detail	Returns one user's profile.
POST /fieldservicegateway/usermanagement/v3/user/location	Assigns or removes users at a location.
PUT /fieldservicegateway/usermanagement/v3/user/identity-status	Turns a user's sign-in on or off.
POST /fieldservicegateway/usermanagement/v3/oauth/username-availability	Checks whether an email can be used as a username.
GET and POST /fieldservicegateway/usermanagement/v3/user-agreement	Reads or records the end-user agreement.
POST /fieldservicegateway/usermanagement/v3/auth/password-change	Changes the signed-in user's password.
POST /fieldservicegateway/usermanagement/v3/auth/forgot-password	Sends a reset code and sets a new password.
POST /fieldservicegateway/usermanagement/v3/oauth/login/init	Starts sign-in and returns the login address.
POST /fieldservicegateway/usermanagement/v3/oauth/login/authorize	Finishes sign-in and returns tokens.
POST /fieldservicegateway/usermanagement/v3/oauth/logout	Ends the user's session.