Índice

type

outline	true

Portuguese (Brasil)

flat

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
email	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	Não	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	*Obrigatório para quem usa SSO

Exemplos de Requisições (Requests)

Corpo da Requisição - Inclusão:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Corpo da Requisição - Alteração Perfil:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Corpo da

requisição

Requisição - Exclusão:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Exemplos de Respostas (Responses)

Resposta quando SUCESSO - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
  "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.

ERRO de

validação

Validação - Code 400:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

}

ERRO de autenticação

ERRO de Autenticação - Code 401:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

ERRO de Permissão - Code 403:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Observação: Verificar as permissões do usuário para acessar a rota/serviço.

English (US)

Users

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

Aviso

title	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
Field	Type	Required	Description	Rules
email	String	Yes	User's e-mail	Campo chave
nome	String	Yes	User's name
perfil	String	Yes	Name of the profile to be assigned to the user
perfilNovo	String	Yes*	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.
localizacao	Array	No	Location linked to the user
remover	String	Yes*	Field to remove the User	*Add the REMOVE parameter to remove the user The field can also be sent blank
login_saml	String	Yes*	Username for SSO	*Mandatory for SSO users

Requests examples:

Request Body - Inclusion:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Request Body - Profile Change:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Request Body - Exclusion:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Response examples:

Response when SUCCESS - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Dica

title	tip

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

Validation ERROR - Code 400:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Authentitcation ERROR - Code 401:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

Permission ERROR - Code 403:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

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

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

Árvore de páginas

Versões comparadas

Versão antiga 6

Nova versão Atual

Chave

Usuários (Users)

Exemplos de Requisições (Requests)

Corpo da Requisição - Inclusão:

Corpo da Requisição - Alteração Perfil:

Corpo da

Requisição - Exclusão:

ERRO de

Validação - Code 400:

ERRO de Autenticação - Code 401:

ERRO de Permissão - Code 403:

Users

Requests examples:

Request Body - Inclusion:

Request Body - Profile Change:

Request Body - Exclusion:

Validation ERROR - Code 400:

Authentitcation ERROR - Code 401:

Permission ERROR - Code 403:

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 6

Nova versão Atual

Chave

Usuários (Users)

Exemplos de Requisições (Requests)

Corpo da Requisição - Inclusão:

Corpo da Requisição - Alteração Perfil:

Corpo da

Requisição - Exclusão:

ERRO de

Validação - Code 400:

ERRO de Autenticação - Code 401:

ERRO de Permissão - Code 403:

Users

Requests examples:

Request Body - Inclusion:

Request Body - Profile Change:

Request Body - Exclusion:

Validation ERROR - Code 400:

Authentitcation ERROR - Code 401:

Permission ERROR - Code 403: