Histórico da Página
| Índice | ||||
|---|---|---|---|---|
|
Usuários (Users)
Serviço utilizado para cadastrar. alterar e remover usuários do Ahgora PontoWeb.
| Aviso |
|---|
Permitido envio em lote, máximo 1000 registros por requisição, ou 1mb (mega) |
Usuários (users)
Item | Descrição |
|---|---|
| Fluxo: | Cliente → PontoWeb |
| Rota | https://api.ahgora.com.br/users |
| Método: | POST |
| Usuários - Users | ||||
| Campo | Tipo | Obrig. | Descrição | Regra |
| String | Sim | E-mail do Usuário | Campo chave | |
| nome | String | Sim | Nome do Usuário | |
| perfil | String | Sim | Nome do perfil a ser atribuído ao usuário | |
| perfilNovo | String | *Sim | Nome do perfil novo a ser atribuído ao usuário | *Opcional, enviar somente quando deseja trocar o perfil do usuário, informando neste campo o novo perfil a ser atribuído. |
| localizacao | Array | Localização vinculada ao usuário | ||
| remover | String | *Sim | Campo para remover o Usuário | *Adicione o parâmetro REMOVER para remover o usuário O campo também pode ser enviado em branco |
| login_saml | String | Sim | Nome de usuário para o SSO | |
Exemplo de corpo da requisição - Inclusão:
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
[
{
"email": "[email protected]",
"perfil": "Administrador",
"localizacao": [
"Human Resources","Fabrica1"
],
"login_saml": "[email protected]",
"nome": "John Doe"
}
] |
Exemplo de corpo da requisição - Alteração Perfil:
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
[
{
"email": "[email protected]",
"perfil": "Administrador",
"localizacao": [
"Human Resources"
],
"login_saml": "[email protected]",
"nome": "John Doe",
"perfilNovo": "Apontador"
}
] |
Exemplo de corpo da requisição - Exclusão:
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
[
{
"email": "[email protected]",
"perfil": "Administrador",
"localizacao": [
"Human Resources"
],
"login_saml": "[email protected]",
"nome": "John Doe",
"remover": "REMOVER"
}
] |
Exemplo de resposta quando sucesso - 200:
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"company": "a000101",
"unique": "bd751350",
"subunique": "c01de0cc",
"message": "User´s Integration on progress"
} |
| Dica |
|---|
Para obter mais detalhe, utilize o serviço Process. Para saber mais entre no link. |
Exemplo de erro de validação - Code 400:
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"error": {
"message": "Request format must be an Array",
"code": 400
}
} |
Exemplo de erro de autenticação - Code 401:
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"company": "a000101",
"unique": "bd751350",
"subunique": "c01de0cc",
"message": "User´s Integration on progress"
} |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas