2.0info: 8.3.0 Usuários description: Responsável pelo novo serviço de usuários da plataforma G7. x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: user contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /platform/user/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /actions/generateImpersonationToken: post: description: Gera um token para personificação com base no usuário da mensagem corrente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – password properties: password: type: string description: Senha do usuário para gerar o token responses: 200: description: Ok 400: description: Nome do grupo inválido. default: description: Error response schema: #/definitions/genericError /actions/finalizeImpersonation: post: description: Finaliza a personificação do usuário x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – username properties: username: type: string description: Username do usuário que será finalizado a personificação responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /queries/getUser: post: description: API DEPRECIADA: Use getUser version 8 instead. | DATA: 2022-01-14 | Retorna as informações básicas do usuário passado como parâmetro. Se o usuário não for informado, retorna os dados do usuário corrente (que efetuou o login) x-senior-event: false deprecated: true tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: username: type: string description: Nome do usuário no formato nome@dominio_tenant responses: 200: description: Ok schema: type: object required: – id – username – fullName – email – tenantDomain – tenantName – tenantLocale – blocked – authenticationType – integration – photo – admin – allowedToChangePassword properties: id: type: string description: Identificador do usuário username: type: string description: Nome do usuário fullName: type: string description: Nome completo do usuário description: type: string description: Descrição do usuário email: type: string description: Endereço de e-mail do usuário locale: type: string description: localidade do usuário tenantDomain: type: string description: Domínio do tenant no login do usuário tenantName: type: string description: Nome do tenant do usuário tenantLocale: type: string description: Localidade do tenant do usuário blocked: type: boolean description: Indica se o usuário está bloqueado authenticationType: #/definitions/authType integration: #/definitions/integration changePassword: type: boolean description: Indica se o usuário precisa trocar de senha no próximo logon photo: type: string description: DEPRECADO: Essa propriedade só será retornada na versão descontinuada da primitiva getUser. Utilize a versão atual. Foto do usuário em Base64 properties: #/definitions/property admin: type: boolean description: Indica se o usuário é um admin de tenant allowedToChangePassword: type: boolean description: Indica se o usuário pode alterar a sua senha.
É possível alterar a senha quando o tipo de autenticação do tenant é G7 ou quando é G5 e o tenant está configurado para permitir alterar a senha pela G7. expirationDate: type: string description: Data de expiração do usuário em UTC. timezone: type: integer description: Timezone em minutos do usuário photoUrl: type: string description: URL da foto do usuário armazenada no blob-service photoUrlExpirationDate: type: string description: Data de expiração da URL da foto do usuário phoneNumber: type: string description: Campo de Telefone (Opcional) 404: description: Objeto não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido default: description: Error response schema: #/definitions/genericError /getUser (v8): post: description: Retorna as informações básicas do usuário passado como parâmetro. Se o usuário não for informado, retorna os dados do usuário corrente (que efetuou o login) x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – in: header name: accept description: _MIME type_ e versão do endpoint utilizado na requisição. [SAIBA MAIS](https://dev.senior.com.br/documentacao/guia-de-api/versionamento/). type: string default: application/json;seniorx.version=8 – name: input in: body required: true schema: type: object properties: username: type: string description: Nome do usuário no formato nome@dominio_tenant includePhoto: type: boolean description: Informa se deve trazer a URL da foto do usuário responses: 200: description: Ok schema: type: object required: – id – username – fullName – email – tenantDomain – tenantName – tenantLocale – blocked – authenticationType – integration – photo – admin – allowedToChangePassword properties: id: type: string description: Identificador do usuário username: type: string description: Nome do usuário fullName: type: string description: Nome completo do usuário description: type: string description: Descrição do usuário email: type: string description: Endereço de e-mail do usuário locale: type: string description: localidade do usuário tenantDomain: type: string description: Domínio do tenant no login do usuário tenantName: type: string description: Nome do tenant do usuário tenantLocale: type: string description: Localidade do tenant do usuário blocked: type: boolean description: Indica se o usuário está bloqueado authenticationType: #/definitions/authType integration: #/definitions/integration changePassword: type: boolean description: Indica se o usuário precisa trocar de senha no próximo logon photo: type: string description: DEPRECADO: Essa propriedade só será retornada na versão descontinuada da primitiva getUser. Utilize a versão atual. Foto do usuário em Base64 properties: #/definitions/property admin: type: boolean description: Indica se o usuário é um admin de tenant allowedToChangePassword: type: boolean description: Indica se o usuário pode alterar a sua senha.
É possível alterar a senha quando o tipo de autenticação do tenant é G7 ou quando é G5 e o tenant está configurado para permitir alterar a senha pela G7. expirationDate: type: string description: Data de expiração do usuário em UTC. timezone: type: integer description: Timezone em minutos do usuário photoUrl: type: string description: URL da foto do usuário armazenada no blob-service photoUrlExpirationDate: type: string description: Data de expiração da URL da foto do usuário phoneNumber: type: string description: Campo de Telefone (Opcional) 404: description: Objeto não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido default: description: Error response schema: #/definitions/genericError /actions/updateGroup: post: description: Atualiza as informações e os usuários de um grupo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do grupo name: type: string description: Nome do grupo description: type: string description: Descrição do grupo email: type: string description: E-mail do grupo usersToAdd: type: array items: type: string description: Usuários a serem incluídos no grupo usersToRemove: type: array items: type: string description: Usuários a serem excluídos do grupo responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do grupo que foi atualizado 404: description: Objeto não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 409: description: Objeto já existente default: description: Error response schema: #/definitions/genericError /queries/listImpersonationHistory: post: description: Retorna o histório de personificação com base nos parâmetros informados x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: pagination: #/definitions/pagination impersonatedUsername: type: string description: Username do usuário solicitante da personificação tenant: type: string description: Nome do tenant from: type: string description: Data inicial to: type: string description: Data final status: #/definitions/impersonationStatus responses: 200: description: Ok schema: type: object required: – content – listInformation properties: content: #/definitions/impersonationHistory listInformation: #/definitions/listInformation default: description: Error response schema: #/definitions/genericError /actions/generatePasswordChangeToken: post: description: Gera um token temporário para troca de senha x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – username properties: username: type: string description: Nome do usuário responses: 200: description: Ok schema: type: object required: – token properties: token: type: string description: Token temporário para troca de senha default: description: Error response schema: #/definitions/genericError /queries/getAdminInfo: post: description: Retorna as informações do administrador do tenant com base no contexto x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – domainName – password properties: domainName: type: string description: Nome do domínio password: type: string description: Senha default: description: Error response schema: #/definitions/genericError /actions/updateGroupUsers: post: description: Adiciona e/ou remove usuários de um grupo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – groupId properties: usersToAdd: type: array items: type: string description: Lista de usuários que serão incluídos usersToRemove: type: array items: type: string description: Lista de usuários que serão removidos groupId: type: string description: Identificador do Grupo responses: 200: description: Ok 404: description: Objeto não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /anonymous/actions/requestPasswordChange: post: description: Envia um e-mail para o usuário, com as instruções para troca de senha x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – username – baseURL properties: username: type: string description: Nome do usuário, no formato nome@dominio_tenant, por exemplo: joao@senior.com.br baseURL: type: string description: Endereço base da página de troca de senha, que será enviado ao usuário via e-mail captcha: type: string description: Resposta do captcha para liberar a operação – é desnecessário ou obrigatório, dependendo da configuração do ambiente responses: 200: description: Ok schema: type: object required: – recipient properties: recipient: type: string description: Endereço de e-mail ofuscado, para qual foi enviada as instruções de troca de senha default: description: Error response schema: #/definitions/genericError /actions/impersonate: post: description: Personificar usuário x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – username properties: username: type: string description: Username do usuário que será personificado responses: 200: description: Ok schema: type: object required: – token properties: token: type: string description: Retorna o token para personificação default: description: Error response schema: #/definitions/genericError /queries/listUsersToImpersonate: post: description: Obtém a lista de todos os usuário disponíveis para personificação, sendo possível filtrar por nome de usuário e tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no nome do usuário e tenant includeImpersonated: type: boolean description: Inclui usuários que já foram personificados pagination: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – impersonationUsers – listInformation properties: impersonationUsers: #/definitions/impersonationUser listInformation: #/definitions/listInformation default: description: Error response schema: #/definitions/genericError /actions/revokeImpersonation: post: description: Revoga a solicitação da personificação do usuário do contexto x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /queries/getUserPhoto: post: description: Retorna a URL da foto do usuário, armazenada no blob-service. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: username: type: string description: Nome do usuário no formato nome@dominio_tenant responses: 200: description: Ok schema: type: object required: – url – urlExpirationDate properties: url: type: string description: URL da foto do usuário urlExpirationDate: type: string description: Data de expiração da URL da foto do usuário 404: description: Objeto não encontrado 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /queries/listUserGroups: post: description: Obtem a lista de grupos do usuário x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – username properties: username: type: string description: Nome do usuário searchValue: type: string description: Termo para buscar nos campos nome e e-mail. pagination: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – groups – listInformation properties: groups: #/definitions/group listInformation: #/definitions/listInformation default: description: Error response schema: #/definitions/genericError /actions/createGroup: post: description: Insere um novo grupo na base x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome do grupo description: type: string description: Descrição do grupo email: type: string description: E-mail do grupo users: type: array items: type: string description: Lista de usuários a serem associados ao grupo responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do grupo que foi inserido na base 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 409: description: Objeto já existente default: description: Error response schema: #/definitions/genericError /queries/listUsersByIds: post: description: Obtem a lista de usuários pelos ids x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – userIds properties: tenantName: type: string description: Tenant que deseja buscar os usuários, apenas permitido para master userIds: type: array items: type: string description: Ids dos usuários. responses: 200: description: Ok schema: type: object properties: users: #/definitions/basicUser default: description: Error response schema: #/definitions/genericError /actions/updateUser: post: description: Altera as informações de um usuário x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: username: type: string description: Nome do usuário fullName: type: string description: Nome completo do usuário email: type: string description: Endereço de e-mail do usuário description: type: string description: Descrição do usuário locale: type: string description: Idioma preferêncial do usuário photo: type: string description: Foto do usuário em Base64 blocked: type: boolean description: Indica se o usuário está bloqueado changePassword: type: boolean description: Indica se o usuário precisa trocar de senha no próximo logon properties: type: array items: #/definitions/property description: Lista com as propriedades que este usuário possui (opcional) phoneNumber: type: string description: Campo informativo para numero de telefone do usuário (opcional) responses: 200: description: Ok schema: type: object required: – username properties: username: type: string description: Nome do usuário que foi atualizado 404: description: Objeto não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getUserImpersonation: post: description: Retorna informações do usuário da personificação do contexto x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: impersonation: #/definitions/impersonationUser default: description: Error response schema: #/definitions/genericError /queries/listUsersByNames: post: description: Obtem a lista de usuários pelos nomes x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – userNames properties: tenantName: type: string description: Tenant que deseja buscar os usuários, apenas permitido para master userNames: type: array items: type: string description: Nomes dos usuários. responses: 200: description: Ok schema: type: object properties: users: #/definitions/basicUser default: description: Error response schema: #/definitions/genericError /actions/changePassword: post: description: Atualiza a senha de um usuário
Essa primitiva possui campos de senha criptografados, o que pode impossibilitar a customização da API x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – newPassword properties: username: type: string description: Nome do usuário currentPassword: type: string description: Senha atual do usuário newPassword: type: string description: Nova senha do usuário responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /anonymous/actions/changePasswordWithToken: post: description: Faz a troca da senha do usuário, autorizada através do token passado
Essa primitiva possui campos de senha criptografados, o que pode impossibilitar a customização da API x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – in: header name: X-Tenant description: Nome do tenant type: string – in: header name: X-TenantDomain description: Domínio tenant type: string – name: input in: body required: true schema: type: object required: – token – username – newPassword properties: token: type: string description: Token enviado para o usuário via e-mail, através da ação 'generatePasswordChangeToken' ou 'requestPasswordChange' username: type: string description: Nome do usuário newPassword: type: string description: Nova Senha para o usuário. Esta senha deve respeitar as políticas de senha definidas para o tenant do qual o usuário faz parte responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /queries/listGroupUsers: post: description: Obtém a lista dos usuários do grupo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do grupo. searchValue: type: string description: Termo para buscar nos campos nome, nome completo e e-mail. pagination: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – users – listInformation properties: users: #/definitions/groupBasicUser listInformation: #/definitions/listInformation 404: description: Objeto não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/removeGroup: post: description: Remove o grupo e os vínculos dos usuários x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do grupo responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /queries/listUsers: post: description: Obtem a lista de usuários x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: Tenant que deseja buscar os usuários, apenas permitido para master pagination: #/definitions/pagination ordination: #/definitions/ordination includeBlocked: type: boolean description: Incluir usuários bloqueados, por padrão será true searchTerm: type: string description: Termo para buscar nos campos nome, nome completo, celular e e-mail users: type: array items: type: string description: Lista de usuários específicos (campo name, e-mail, cell_phone, fullName) para filtrar somente os dados destes authenticationTypes: type: array items: #/definitions/authType description: Tipos de autenticação responses: 200: description: Ok schema: type: object required: – users – listInformation properties: users: #/definitions/basicUser listInformation: #/definitions/listInformation default: description: Error response schema: #/definitions/genericError /queries/getGroup: post: description: Retorna as informações de um grupo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: Identificador do grupo name: type: string description: Nome do grupo responses: 200: description: Ok schema: type: object required: – id – name properties: id: type: string description: Identificador do Grupo name: type: string description: Nome do Grupo description: type: string description: Descrição do Grupo email: type: string description: E-mail do grupo users: #/definitions/groupBasicUser 404: description: Objeto não encontrado 403: description: Permissão negada 401: description: Usuário ou senha inválido default: description: Error response schema: #/definitions/genericError /actions/deleteUser: post: description: Exclui o usuário da base x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – username properties: username: type: string description: Username do usuário que será excluído responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /queries/listGroups: post: description: Obtém a lista de todos os grupos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no nome do grupo tenant: type: string description: Tenant que deseja buscar os grupos, apenas permitido para master pagination: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – groups – listInformation properties: groups: #/definitions/group listInformation: #/definitions/listInformation 403: description: Permissão negada 401: description: Usuário ou senha inválido default: description: Error response schema: #/definitions/genericError /actions/createUser: post: description: Insere um novo usuário na base x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – username – fullName – email – password – blocked – changePassword properties: username: type: string description: Nome (username) do usuário fullName: type: string description: Nome completo do usuário email: type: string description: Endereço de e-mail do usuário password: type: string description: Senha do usuário description: type: string description: Descrição do usuário (opcional) blocked: type: boolean description: Indica se o usuário está ou não bloqueado changePassword: type: boolean description: Indica se o usuário precisa trocar a senha no próximo logon photo: type: string description: Foto do usuário, em Base64. (opcional) locale: type: string description: Localidade do usuário properties: type: array items: #/definitions/property description: Lista com as propriedades que este usuário possui (opcional) phoneNumber: type: string description: Campo informativo para numero de telefone do usuário (opcional) responses: 200: description: Ok schema: type: object required: – username properties: username: type: string description: Nome do usuário recém criado 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 409: description: Objeto já existente default: description: Error response schema: #/definitions/genericError /signals/alterAuthenticationTypeAllUsers: post: description: Altera o tipo de autenticação de todos os usuários x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – currentAuthenticationType – newAuthenticationType properties: currentAuthenticationType: #/definitions/authType newAuthenticationType: #/definitions/authType responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /signals/deleteUsers: post: description: Exclui os usuários da base x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – usernames properties: usernames: type: array items: type: string description: Lista de usernames dos usuários que serão excluídos responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /signals/listUsersAlterTypeAuthentication: post: description: Recebe uma lista de usuários que irá ter o tipo de autenticação alterado. x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – currentAuthenticationType – newAuthenticationType – users properties: currentAuthenticationType: #/definitions/authType newAuthenticationType: #/definitions/authType users: type: array items: type: string description: Lista de usuários que irá ter o tipo de autenticação alterada responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /events/usersChanged: post: description: Informa que usuários foram alterados x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – created – updated – deleted properties: created: type: array items: #/definitions/changedUser description: Usuários criados. updated: type: array items: #/definitions/changedUser description: Usuários alterados. deleted: type: array items: type: string description: Usuários excluídos. responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /events/adminUserChanged: post: description: Informa que um usuário administrador de um tenant foi alterado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – tenantName – fullName – email properties: tenantName: type: string description: Nome do tenant alterado fullName: type: string description: Nome alterado do administador do tenant. email: type: string description: e-mail alterado do administador do tenant. responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /events/groupChanged: post: description: Informa que um grupo foi alterado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id – name properties: id: type: string description: Identificador do grupo name: type: string description: Nome do grupo oldName: type: string description: Nome antigo do grupo se alterado description: type: string description: Descrição do grupo email: type: string description: E-mail do grupo usersIncluded: type: array items: type: string description: Nome dos usuários que foram incluídos no grupo, com domínio (<usuário>@<domínio.com>) usersRemoved: type: array items: type: string description: Nome dos usuários que foram removidos do grupo, com domínio (<usuário>@<domínio.com>) groupCreated: type: boolean description: Indica se o grupo é novo ou foi alterado responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /events/groupRemoved: post: description: Informa que um grupo foi removido x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id – name properties: id: type: string description: Identificador do grupo name: type: string description: Nome do grupo responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /events/changedIntegrator: post: description: Notifica uma alteração no integrador x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – tenant – integrator properties: tenant: type: string description: Nome do tenant integrator: type: string description: Integrador exemplo: domain/service/<identifier> responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: impersonationStatus: type: string enum: – GENERATED – IMPERSONATED – REVOKED – USER_REVOKED – EXPIRED authType: type: string enum: – G7 – G5 – LDAP – SAML sortOrder: type: string enum: – DESC – ASC impersonationUser: type: object required: – username – tenant – created – impersonated properties: username: type: string description: Nome do usuário passível de personificação tenant: type: string description: Tenant do usuário em questão created: type: string description: Data em que o usuário se submeteu a personificação format: date-time impersonated: type: boolean description: Indica se o usuário já foi personificado impersonationHistory: type: object required: – tenant – impersonatedUsername – impersonatorUsername – created – status properties: tenant: type: string description: Nome do tenant impersonatedUsername: type: string description: Username do usuário solicitante do atendimento impersonatorUsername: type: string description: Username do usuário que atendeu a solicitação do atendimento created: type: string description: Data e hora que ocorreu o evento format: date-time status: #/definitions/impersonationStatus pagination: type: object properties: pageNumber: type: integer description: O número da página retornado. A primeira página corresponde ao índice 0 pageSize: type: integer description: Quantidade de registros por página ordination: type: object properties: sortBy: type: string description: Nome do campo pelo qual resultado será ordenado. sortOrder: #/definitions/sortOrder listInformation: type: object required: – totalElements – totalPages properties: totalElements: type: integer description: Quantidade total de resultados encontrados totalPages: type: integer description: Quantidade total de páginas encontradas group: type: object required: – id – name properties: id: type: string description: Identificador do Grupo name: type: string description: Nome do Grupo description: type: string description: Descrição do Grupo email: type: string description: E-mail do grupo property: type: object required: – name – value properties: name: type: string description: Nome da propriedade value: type: string description: Valor da propriedade groupBasicUser: type: object required: – username – fullName – email – blocked – authenticationType properties: username: type: string description: Nome do Usuário fullName: type: string description: Nome completo do usuário email: type: string description: Endereço de e-mail do usuário blocked: type: boolean description: Indica se o usuário está bloqueado authenticationType: #/definitions/authType basicUser: type: object required: – id – username – fullName – email – tenantDomain – tenantName – tenantLocale – blocked – authenticationType – integration properties: id: type: string description: Identificador do usuário username: type: string description: Nome do usuário fullName: type: string description: Nome completo do usuário description: type: string description: Descrição do usuário email: type: string description: Endereço de e-mail do usuário locale: type: string description: localidade do usuário tenantDomain: type: string description: Domínio do tenant no login do usuário tenantName: type: string description: Nome do tenant do usuário tenantLocale: type: string description: Localidade do tenant do usuário blocked: type: boolean description: Indica se o usuário está bloqueado authenticationType: #/definitions/authType integration: #/definitions/integration integration: type: object required: – integrationName properties: integrationName: type: string description: Nome do usuário recebido via integração, caso não tenha um usuário informado na coluna 'integration_username' será retornado o usuário padrão integrationCode: type: string description: Código do usuário, aplicado para os usuários integrados através da G5 changedUser: type: object required: – username – blocked properties: username: type: string description: Nome do usuário, com domínio (<usuário>@<dominio.com>) blocked: type: boolean description: Indicativo se o usuário está bloqueado genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE