Histórico da Página
Document status | Finished |
Date | 2/14/2018 |
Version | 2.0 |
Previous version | 1.0 |
Authors |
Content |
|
Rest users
The SCIM 'users' is a protocol of application REST for the provision and management of identity data in the web. The protocol support the creation, modification, recover and discovery of users.
...
| Aviso | ||
|---|---|---|
| ||
Via REST, you can only perform the basic creation of the user. To configure permissions, accesses, menus etc, you need to use Identity.ty. |
Methods available
GET
Syntax /users/{userId}
To recover a known user, the customers send GET requests. If the user exists, the server responds with the state 200 code and adds result in the body of the answer. You can also list the users of the system, omitting the submission of pathParam {userId}.
Parameters
pathParam
Name | Type | Description | Default |
userId | string | id or user code in the system |
...
Notification:
The parameters attributes is case sensitive.
Return:
Parameters
Body
Name | Type | Description |
totalResults | numeric | Indicates the number of records found |
itemsPerPage | numeric | Number of items returned in the request |
startIndex | numeric | Record "from" the return of records |
Id | string | Id or code of user in Protheus |
goal | jSon | Related to the creation of user |
created | String | Date of user creation. Returns in the format YYYY-MM-DD_HH:MM:SS |
lastModified | String | Data of last change of the user. Returns in the format YYYY-MM-DD_HH:MM:SS |
externalId | string | External code of the user (e-mail for the majority of the systems) |
name | string | Code of user in the system |
givenName | string | First name of the user |
familyName | string | Second name of the user |
displayName | string | name of user in the system |
emails | array of objects | |
emails:value | string | E-mail in the system |
emails:type | string | Type of e-mail. Always return "work" |
primary | boolean | Indicates whether it is the primary e-mail of the user. Always returns true |
active | boolean | Returns whether the user is active in the system |
groups | array of objects | Groups to which the user belongs |
groups:value | string | Group code |
groups:display | string | Group Description |
title | string | User position |
employeeNumber | string | Employee code |
department | string | Code of the user department |
manager | array of objects | Information of the user's leaders |
manager:manageId | string | Code of the user's leader |
manager:displayName | string | Name of the leader in the system |
...
The search for a user by the Id differs only of the omission in the result of parameters _totalResult{_}, _itensPerPage_ and _startIndex{_}.GET (GetUserId)
Syntax /users/GetUserId
Returns id of the user currently logged by the REST service in Protheus.
...
Example of method return
{
"userID": "000000"
}
POST
Syntax /users/{userid}/{operation}
Creates new users in the system developing in the request, when successful, the respond code 201 (created).
Parameters
pathParam
Name | Type | Description | Default |
userId | string | User code in the system (POST to block or unblock an existing user. To block or unblock, send operation parameter) | |
operation | string | Values accepted: activate and deactivate. Indicates whether user is activated in the system (activate) or whether the user is blocked via SAML (deactivate) or whether a new user is created (parameter blank or any other value different than the previous one. If parameter userId is sent, but parameter operation was not sent, we assume a new user was created in the system |
...
| Wiki Markup |
|---|
{
"schemas":\[
"urn:scim:schemas:core:2.0:User",
"urn:scim:schemas:extension:enterprise:2.0:User"
\],
"externalId":"TesteUsr",
"meta":\{
\\
\\
\},
"userName":"Usr Tst",
"displayName":"User",
"title":"Coordenador",
"emails":\[
\{
"value":"[email protected]",
"primary":true
\}
\],
"active":true,
"groups":\[
\{
"value":"000002"
\}
\],
"password":"pass001",
"urn:scim:schemas:extension:totvs:2.0:User/forceChangePassword":true,
"urn:scim:schemas:extension:enterprise:2.0:User/employeeNumber":"02|00|000001",
"urn:scim:schemas:extension:enterprise:2.0:User/department":"RH",
"urn:scim:schemas:extension:totvs:2.0:User/groupRule":2,
"ext/sAMAccountName":"user0007",
"ext/adDomain":"XP01",
"urn:scim:schemas:extension:enterprise:2.0:User":\{
"manager":\[
\{
"managerid":"000000"
\}
\]
\}
\} |
PUT
Syntax /users/{userid}
Method used to update an existing user. All parameters can be sent, such as the POST method.
Parameters
pathParam
Name | Type | Description | Default |
userId * mandatory | string | user code |
Return: true, false or error generated.
DELETE
Syntax /users/{userid}
Method used to block an existing user. User is blocked, and all items bound to its record (groups, functional binding etc) are disassociated.
Parameters
pathParam
Name | Type | Description | Default |
userId * mandatory | string | User code |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas