In the SEM Web Application, a user is created under a company and must be associated with at least one group.
Use the POST method to create a user with the following input:
-
Service Root URI: https://<Server Name>/<IIS Application Name>/sem/v3
-
Resource path: /Companies('CompanyId')/Users
-
The 'Subject' parameter corresponds to the authentication tool's login Username and must be defined uniquely for each user because an encoded value of this parameter is used in API requests to specify a single user (for details, see Run requests for a specific company user). This value is case-sensitive.
-
The 'Subject' parameter for users defined in the Server API must have the same value as the 'Subject' parameter for users defined in the Client Backend to ensure that the access rights for all Smart Engineering Manager activities are applied correctly for each user.
-
For Okta authentication, the 'Subject' parameter must match the value defined in Okta. It is usually assigned the same value as the user's e-mail, although the two values need not be identical.
-
The parameters for the service root URI below are provided as an example. The server and domain name you provide depend on your specific environment.
-
To obtain the 'CompanyId' and 'GroupId' values of the parameters for use in the requests below, run the GET requests described in View groups and roles.
Sample URI for creating a user under a company
POST
https://WebApiServer1.APIServerDomain.com/webapibe3.0/sem/v3/Companies('dfbbe4ae-bfb2-44a3-9169-cd6f9f6159b7')/Users
Sample JSON request
{
"Name": "User A",
"Email": "semadmin@MyDomain.com",
"Subject": "semadmin",
"AssociatedGroups": [
"ebe4c46a-3fab-4123-8ed9-adc33305f72d",
"c3037511-c5e4-4334-b26f-912e6e8a6d62",
"bc755e3d-6533-4a74-8688-84b4ce26ccf2"]
}
Sample URI for creating a user under a company and a single group
POST
https://WebApiServer1.APIServerDomain.com/webapibe3.0/sem/v3/Companies('dfbbe4ae-bfb2-44a3-9169-cd6f9f6159b7')/Groups('bc755e3d-6533-4a74-8688-84b4ce26ccf2')/Users
Sample JSON request
{
"Name": "User B",
"Email": semadmin@MyDomain.com",
"Subject": "semadmin"
}