TOTVS RH Linha Ahgora Integrador

Árvore de páginas

Users


Service used to register, change and remove users from Ahgora PontoWeb.


Alert

Batch sending allowed, maximum 1000 records per request, or 1mb (mega)


Users

Item

Description

Flow:Client → PontoWeb
Route:https://api.ahgora.com.br/users
Method:POST
Users
FieldTypeRequiredDescriptionRules
emailStringYesUser's e-mailCampo chave
nomeStringYesUser's name
perfilStringYesName of the profile to be assigned to the user
perfilNovoStringYes*Name of the new profile to be assigned to the user*Optional, send only when you want to change the user profile, informing in this field the new profile to be assigned.
localizacaoArrayNoLocation linked to the user
removerStringYes*Field to remove the User*Add the REMOVE parameter to remove the user
The field can also be sent blank
login_samlStringYes*Username for SSO

*Mandatory for SSO users


Requests examples:


Request Body - Inclusion:

[
  {
    "email": "[email protected]",
    "perfil": "Administrador",
    "localizacao": [
      "Human Resources","Fabrica1"
    ],
    "login_saml": "[email protected]",
    "nome": "John Doe"
  }
]


Request Body - Profile Change:

[
  {
    "email": "[email protected]",
    "perfil": "Administrador",
    "localizacao": [
      "Human Resources"
    ],
    "login_saml": "[email protected]",
    "nome": "John Doe",
    "perfilNovo": "Apontador"
  }
]


Request Body - Exclusion:

[
  {
    "email": "[email protected]",
    "perfil": "Administrador",
    "localizacao": [
      "Human Resources"
    ],
    "login_saml": "[email protected]",
    "nome": "John Doe",
    "remover": "REMOVER"
  }
]


Response examples:


Response when SUCCESS - Code 200:

{
  "company": "a000101",
  "unique": "bd751350",
  "subunique": "c01de0cc",
  "message": "User´s Integration on progress"
}

tip

For more details, use the Process service. To find out more, click here.


Validation ERROR - Code 400:

{
  "error": {
    "message": "Request format must be an Array",
    "code": 400
  }
}


Authentitcation ERROR - Code 401:

{
  "company": "a000101",
  "unique": "bd751350",
  "subunique": "c01de0cc",
  "message": "User´s Integration on progress"
}


Permission ERROR - Code 403:

{
    "error": {
        "message": "Forbidden",
        "code": 403
    }
}

Note: Check the user's permissions to access the route/service.