Mais pesquisados:Customização, Tutorial, Documentação

userManager

1536 views 0 09/07/2019 Atualizado em 28/10/2024 integrador

2.0info: 32.1.2 userManager x-senior-domain: usuarios x-senior-domain-path: usuarios x-senior-service-path: userManager contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/usuariossecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /userManager/queries/healthcheck: post: description: Verifica se o serviço está funcionando tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Itens verificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o serviço está funcionando tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Itens verificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/queries/obterMeusDados: post: description: API DEPRECIADA: Use platform/user/queries/getUser instead | DATA: 2019-10-10 | Retorna as informações básicas do usuário que chamou a mensagem. Não precisa enviar nenhum parâmetro, pois retorna os dados do usuário corrente (que efetuou o login) tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – id – nome – nomeCompleto – descricao – email – localidade – tenantDomain – tenantName – tenantLocale – bloqueado properties: id: type: string description: Identificador do usuário nome: type: string description: Nome do usuário nomeCompleto: type: string description: Nome completo do usuário descricao: type: string description: Descrição do usuário email: type: string description: Endereço de email do usuário localidade: type: string description: localidade do usuário logado tenantDomain: type: string description: Domínio do tenant no login do usuário tenantName: type: string description: Nome do tenant do usuario logado tenantLocale: type: string description: Localidade do tenant do usuario logado bloqueado: type: boolean description: Indica se o usuário está bloqueado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Use platform/user/queries/getUser instead | DATA: 2019-10-10 | Retorna as informações básicas do usuário que chamou a mensagem. Não precisa enviar nenhum parâmetro, pois retorna os dados do usuário corrente (que efetuou o login) tags: – Queries deprecated : true x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – id – nome – nomeCompleto – descricao – email – localidade – tenantDomain – tenantName – tenantLocale – bloqueado properties: id: type: string description: Identificador do usuário nome: type: string description: Nome do usuário nomeCompleto: type: string description: Nome completo do usuário descricao: type: string description: Descrição do usuário email: type: string description: Endereço de email do usuário localidade: type: string description: localidade do usuário logado tenantDomain: type: string description: Domínio do tenant no login do usuário tenantName: type: string description: Nome do tenant do usuario logado tenantLocale: type: string description: Localidade do tenant do usuario logado bloqueado: type: boolean description: Indica se o usuário está bloqueado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/queries/listUsers: post: description: API DEPRECIADA: Use platform/user/queries/listUsers instead | DATA: 2019-10-10 | Lista os usuários de forma paginada, permitindo ordenar e filtrar pelos campos nome, nomeCompleto e email. tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Indica qual página deseja-se buscar, por padrão será 1 count: type: integer format: int64 description: Indica qual a quantidade de usuários é mostrada em cada página, por padrão será 10 sortBy: type: string description: Nome do campo pelo qual os usuários são ordenados, por padrão será pelo campo nome sortOrder: type: string description: Indica se a ordenação deve ser em ordem ASC ou DESC, por padrão será ASC 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 e e-mail users: type: array items: type: string description: Lista de usuários específicos (campo nome) para filtrar somente os dados destes responses: 200: description: Ok schema: type: object required: – users – pages – total properties: users: type: array items: type: object allOf: – #/definitions/userBasicInfo minimum: 1 description: Lista de usuários. Retorna as mesmas informações do obterMeusDados pages: type: integer format: int64 description: Total de páginas total: type: integer format: int64 description: Total de registros encontrados na consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Use platform/user/queries/listUsers instead | DATA: 2019-10-10 | Lista os usuários de forma paginada, permitindo ordenar e filtrar pelos campos nome, nomeCompleto e email. tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: page description: Indica qual página deseja-se buscar, por padrão será 1 in: query type: integer format: int64 – name: count description: Indica qual a quantidade de usuários é mostrada em cada página, por padrão será 10 in: query type: integer format: int64 – name: sortBy description: Nome do campo pelo qual os usuários são ordenados, por padrão será pelo campo nome in: query type: string – name: sortOrder description: Indica se a ordenação deve ser em ordem ASC ou DESC, por padrão será ASC in: query type: string – name: includeBlocked description: Incluir usuários bloqueados, por padrão será true in: query type: boolean – name: searchTerm description: Termo para buscar nos campos nome, nome completo e e-mail in: query type: string – name: users description: Lista de usuários específicos (campo nome) para filtrar somente os dados destes in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – users – pages – total properties: users: type: array items: type: object allOf: – #/definitions/userBasicInfo minimum: 1 description: Lista de usuários. Retorna as mesmas informações do obterMeusDados pages: type: integer format: int64 description: Total de páginas total: type: integer format: int64 description: Total de registros encontrados na consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/queries/obterDadosUsuario: post: description: API DEPRECIADA: Use platform/user/queries/getUser instead | DATA: 2019-10-10 | Retorna as informações básicas do usuário passado como parâmetro. tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nome properties: nome: type: string description: Nome do usuário no formato nome@dominio_tenant responses: 200: description: Ok schema: type: object required: – id – nome – nomeCompleto – descricao – email – localidade – tenantDomain – tenantName – tenantLocale properties: id: type: string description: Identificador do usuário nome: type: string description: Nome do usuário nomeCompleto: type: string description: Nome completo do usuário descricao: type: string description: Descrição do usuário email: type: string description: Endereço de email do usuário localidade: type: string description: localidade do usuário logado tenantDomain: type: string description: Domínio do tenant no login do usuário tenantName: type: string description: Nome do tenant do usuario logado tenantLocale: type: string description: Localidade do tenant do usuario logado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Use platform/user/queries/getUser instead | DATA: 2019-10-10 | Retorna as informações básicas do usuário passado como parâmetro. tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: nome description: Nome do usuário no formato nome@dominio_tenant in: query required: true type: string responses: 200: description: Ok schema: type: object required: – id – nome – nomeCompleto – descricao – email – localidade – tenantDomain – tenantName – tenantLocale properties: id: type: string description: Identificador do usuário nome: type: string description: Nome do usuário nomeCompleto: type: string description: Nome completo do usuário descricao: type: string description: Descrição do usuário email: type: string description: Endereço de email do usuário localidade: type: string description: localidade do usuário logado tenantDomain: type: string description: Domínio do tenant no login do usuário tenantName: type: string description: Nome do tenant do usuario logado tenantLocale: type: string description: Localidade do tenant do usuario logado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/queries/obtemUsuarioPeloNome: post: description: API DEPRECIADA: Use user/getUser instead | DATA: 2021-01-22 | Obtém um usuário pelo nome. tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeUsuario properties: nomeUsuario: type: string description: Nome do usuário. responses: 200: description: Ok schema: type: object properties: usuario: type: object allOf: – #/definitions/userInfo description: Dados do usuário solicitado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Use user/getUser instead | DATA: 2021-01-22 | Obtém um usuário pelo nome. tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: nomeUsuario description: Nome do usuário. in: query required: true type: string responses: 200: description: Ok schema: type: object properties: usuario: type: object allOf: – #/definitions/userInfo description: Dados do usuário solicitado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/queries/listaUsuariosCompletosPapel: post: description: API DEPRECIADA: Use platform/authorization/queries/getAssignedUsers instead | DATA: 2019-08-31 | Lista os informações completas dos usuários que possuem um determinado papel tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do Papel responses: 200: description: Ok schema: type: object required: – usuarios properties: usuarios: type: array items: type: object allOf: – #/definitions/Usuario minimum: 1 description: Lista com os usuarios que possuem o papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Use platform/authorization/queries/getAssignedUsers instead | DATA: 2019-08-31 | Lista os informações completas dos usuários que possuem um determinado papel tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: idPapel description: Identificador do Papel in: query required: true type: string responses: 200: description: Ok schema: type: object required: – usuarios properties: usuarios: type: array items: type: object allOf: – #/definitions/Usuario minimum: 1 description: Lista com os usuarios que possuem o papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/queries/listaPapeisUsuario: post: description: API DEPRECIADA: Use platform/authorization/queries/getUserRoles instead | DATA: 2019-08-31 | Lista os papéis de um usuário tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario properties: idUsuario: type: string description: Identificador do Usuário responses: 200: description: Ok schema: type: object required: – papeis properties: papeis: type: array items: type: object allOf: – #/definitions/recPapel minimum: 1 description: Lista com os ids dos papéis associados ao usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Use platform/authorization/queries/getUserRoles instead | DATA: 2019-08-31 | Lista os papéis de um usuário tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: idUsuario description: Identificador do Usuário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – papeis properties: papeis: type: array items: type: object allOf: – #/definitions/recPapel minimum: 1 description: Lista com os ids dos papéis associados ao usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/queries/obtemPapeisUsuario: post: description: API DEPRECIADA: Use platform/authorization/queries/getUserRoles instead | DATA: 2020-02-29 | Lista os papeis do usuário que executou a primitiva (a partir do username do cabeçalho da mensagem) tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – papeis properties: papeis: type: array items: type: object allOf: – #/definitions/recPapel minimum: 1 description: Lista com os papéis associados ao usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Use platform/authorization/queries/getUserRoles instead | DATA: 2020-02-29 | Lista os papeis do usuário que executou a primitiva (a partir do username do cabeçalho da mensagem) tags: – Queries deprecated : true x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – papeis properties: papeis: type: array items: type: object allOf: – #/definitions/recPapel minimum: 1 description: Lista com os papéis associados ao usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/queries/listaUsuarios: post: description: API DEPRECIADA: Use user/listUsers instead | DATA: 2021-01-22 | Obtém uma lista com os principais dados dos usuários tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – usuarios properties: usuarios: type: array items: type: object allOf: – #/definitions/userInfo minimum: 1 description: Lista com todos os usuários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Use user/listUsers instead | DATA: 2021-01-22 | Obtém uma lista com os principais dados dos usuários tags: – Queries deprecated : true x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – usuarios properties: usuarios: type: array items: type: object allOf: – #/definitions/userInfo minimum: 1 description: Lista com todos os usuários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/actions/sincronizaUsuariosLDAP: post: description: API DEPRECIADA: Use user/synchronizeLDAPUsers instead | DATA: 2024-01-25 | Efetua a sincronização dos usuários entre o servidor LDAP e a base local tags: – Actions deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeTenant properties: nomeTenant: type: string description: Nome do tenant para sincronizar os usuários responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Booleano indicando se a sincronização foi efetuada com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/actions/verificaPermissoesRecursos: post: description: API DEPRECIADA: Use platform/authorization/queries/checkAccess instead | DATA: 2019-08-31 | Verifica permissões em várias ações para vários recursos tags: – Actions deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – recursos properties: nomeUsuario: type: string description: Nome do usuário. Se não for informado será utilizado o usuário da mensagem. recursos: type: array items: type: object allOf: – #/definitions/recRecurso minimum: 1 description: Lista dos recursos para verificação de permissão responses: 200: description: Ok schema: type: object required: – permissoes properties: permissoes: type: array items: type: object allOf: – #/definitions/recRecursoPermissao minimum: 1 description: Lista de permissões para cada recurso e ações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/actions/adicionaPapelUsuario: post: description: API DEPRECIADA: Use platform/authorization/actions/assignUsers or platform/authorization/actions/reassignUsers instead | DATA: 2019-08-31 | Adiciona um papel a um usuário tags: – Actions deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario – idPapel properties: idUsuario: type: string description: Identificador do Usuário idPapel: type: string description: Identificador do Papel responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um boolean com TRUE, apenas para o API Manager não gerar erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/actions/removePapelUsuario: post: description: API DEPRECIADA: Use platform/authorization/actions/unassignUsers or platform/authorization/actions/reassignUsers instead | DATA: 2019-08-31 | Remove o papel de um usuário. Um usuário deve ter ao menos um papel atribuído. Caso seja feita uma tentativa de excluir todos os papéis, uma exceção será lançada. tags: – Actions deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario – idPapel properties: idUsuario: type: string description: Identificador do Usuário idPapel: type: string description: Identificador do Papel responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um boolean com TRUE, apenas para o API Manager não gerar erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/actions/requestUploadFile: post: description: Solicitação para realizar o upload de um arquivo. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado. responses: 200: description: Ok schema: type: object required: – fileId – fileName – version – locationURI properties: fileId: type: string description: O identificador único do arquivo. fileName: type: string description: Nome do arquivo. type: string description: Versão do arquivo. locationURI: type: string description: URI onde o upload deve ser realizado. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/actions/commitUploadedFile: post: description: Realiza o commit de um arquivo que foi carregado anteriormente. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileId – fileName – version properties: fileId: type: string description: O identificador único do arquivo. fileName: type: string description: Nome do arquivo. type: string description: Versão do arquivo. responses: 200: description: Ok schema: type: object required: – fileId – fileName properties: fileId: type: string description: O identificador único do arquivo. fileName: type: string description: Nome do arquivo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/actions/removePendencyWithError: post: description: Remove uma pendencia com erro tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: id da pendencia responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um boolean com TRUE caso operação foi realizada com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/signals/importUsersFromFile: post: description: Realiza a importação de usuários informados em um arquivo CSV. O arquivo deve estar disponível no Blob Service, utilize o endpoint requestUploadFile solicitar o envio do arquivo. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – fileId – fileName properties: fileId: type: string description: O identificador do arquivo que contém os usuários a serem importados. fileName: type: string description: Nome do arquivo que contém os usuários a serem importados. changePasswordAfterLogin: type: boolean description: Identifica se os usuários deverão trocar a senha após o login em caso de autenticação G7 default: false responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /userManager/signals/publishEvent: post: description: Publicar eventos legados relacionados à autorização através dos serviços authorization e authorization-legacy tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – eventType – content properties: eventType: type: string allOf: – #/definitions/eventType description: Tipo do evento content: type: string description: Payload do evento em formato JSON responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /userManager/events/papelAtribuido: post: description: Informa que um usuário teve um novo papel atribuído x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nomeUsuario – nomePapel properties: nomeUsuario: type: string description: Nome do usuário que recebeu o novo papel nomePapel: type: string description: Nome do novo papel associado ao usuário responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/papelRemovido: post: description: Informa que um usuário não exerce mais um determinado papel x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nomeUsuario – nomePapel properties: nomeUsuario: type: string description: Nome do usuário que teve o papel removido nomePapel: type: string description: Nome do papel removido (desassociado) do usuário responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/permissaoIncluida: post: description: Informa que uma permissão de acesso RBAC foi incluída x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nomePapel – uriRecurso – acao properties: nomePapel: type: string description: Nome do papel que recebeu a permissão uriRecurso: type: string description: URI do recurso que foi permitido o acesso acao: type: string description: Nome da ação que foi permitido o acesso responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/permissaoExcluida: post: description: Informa que uma permissão de acesso RBAC foi excluída x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nomePapel – uriRecurso – acao properties: nomePapel: type: string description: Nome do papel que perdeu a permissão uriRecurso: type: string description: URI do recurso que foi excluída a permissao acao: type: string description: Nome da ação que foi removida do papel responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/usersChanged: post: description: Sumariza um grupo de alterações de usuários em um único evento x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – included – changed – removed properties: included: type: array items: type: string minimum: 1 description: [DESCONTINUADO – utilizar campo includedUsersData] Nome dos usuários incluídos includedUsers: type: array items: type: string description: [DESCONTINUADO – utilizar campo includedUsersData] Usuários incluídos (nome com domínio – usuário @ dominio.com ) includedUsersData: type: array items: type: object allOf: – #/definitions/includedUser description: Usuários incluídos changed: type: array items: type: object allOf: – #/definitions/basicUser minimum: 1 description: [DESCONTINUADO – utilizar campo changedUsers] Usuários alterados changedUsers: type: array items: type: object allOf: – #/definitions/changedUser description: Usuários alterados removed: type: array items: type: string minimum: 1 description: [DESCONTINUADO – utilizar campo removedUsers] Nome dos usuários removidos removedUsers: type: array items: type: string description: Usuários removidos (nome com domínio – usuário @ dominio.com ) responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/G5UsersChanged: post: description: Lista com grupo de usuários que foram incluídos, alterados ou removidos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: includedUsers: type: array items: type: object allOf: – #/definitions/includedUser description: Usuários incluídos changedUsers: type: array items: type: object allOf: – #/definitions/changedUser description: Usuários alterados removedUsers: type: array items: type: string description: Usuários removidos (nome com domínio – usuário @ dominio.com ) responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/usuarioExcluido: post: description: Informa que um usuario foi excluido x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nome – nomeUsuario properties: nome: type: string description: [DESCONTINUADO – utilizar campo nomeUsuario] Nome do usuário nomeUsuario: type: string description: Nome do usuário, com domínio ( usuário @ dominio.com ) responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/papelIncluido: post: description: Informa que um papel foi incluido x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nome properties: nome: type: string description: Nome do papel incluído descricao: type: string description: Descrição do papel incluído, se existir responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/papelExcluido: post: description: Informa que um papel foi excluido x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nome properties: nome: type: string description: Nome do papel excluído responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/papelAlterado: post: description: Informa que um papel foi alterado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nome properties: nome: type: string description: Nome do papel alterado descricao: type: string description: Descrição do papel, se existir responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/tenantIncluido: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nome – dominio properties: nome: type: string description: Nome do tenant incluído dominio: type: string description: Domínio do tenant incluído, no formato senior.com.br, por exemplo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/tenantChanged: post: description: Informa que um tenant foi alterado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – name – domain – active properties: name: type: string description: Nome do tenant alterado domain: type: string description: Domínio do tenant alterado, no formato senior.com.br, por exemplo active: type: boolean description: Situação do tenant se ativo ou inativo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/tenantRemoved: post: description: Informa que um tenant foi removido x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – domain properties: domain: type: string description: Domínio do tenant removido, no formato senior.com.br, por exemplo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/grupoIncluido: post: description: Informa que um grupo foi incluido x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nome properties: nome: type: string description: Nome do grupo incluído descricao: type: string description: Descrição do grupo incluído, se existir email: type: string description: Email do grupo, se existir responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/grupoExcluido: post: description: Informa que um grupo foi excluido x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nome properties: nome: type: string description: Nome do grupo excluído responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/events/grupoAlterado: post: description: Informa que um grupo foi alterado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nome properties: nome: type: string description: Nome do grupo alterado descricao: type: string description: Descrição do grupo, se existir email: type: string description: Email do grupo, se existir responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /userManager/entities/Papel: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/Papel responses: 200: description: The created resource schema: #/definitions/Papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/Papel responses: 200: description: The created resource schema: #/definitions/Papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/Papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/entities/Papel/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/Papel responses: 200: description: Ok schema: #/definitions/Papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/Papel responses: 200: description: Ok schema: #/definitions/Papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/Papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/entities/Papel/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/Papel responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/entities/Usuario: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/Usuario responses: 200: description: The created resource schema: #/definitions/Usuario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/Usuario responses: 200: description: The created resource schema: #/definitions/Usuario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/Usuario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/entities/Usuario/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/Usuario responses: 200: description: Ok schema: #/definitions/Usuario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/Usuario responses: 200: description: Ok schema: #/definitions/Usuario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/Usuario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/entities/Usuario/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/Usuario responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/entities/Grupo: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/Grupo responses: 200: description: The created resource schema: #/definitions/Grupo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/Grupo responses: 200: description: The created resource schema: #/definitions/Grupo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/Grupo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/entities/Grupo/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/Grupo responses: 200: description: Ok schema: #/definitions/Grupo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/Grupo responses: 200: description: Ok schema: #/definitions/Grupo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/Grupo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /userManager/entities/Grupo/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/Grupo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthCheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN eventType: description: Tipo de evento type: string enum: – PAPEL_INCLUIDO – PAPEL_EXCLUIDO – PAPEL_ALTERADO – PAPEL_ATRIBUIDO – PAPEL_REMOVIDO – PERMISSAO_INCLUIDA – PERMISSAO_EXCLUIDA userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT checkDTO: description: Itens verificados no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthCheckStatus description: Status userBasicInfo: description: type: object required: – id – name – fullName – description – email – locale – tenantDomain – tenantName – tenantLocale – blocked properties: id: type: string description: Identificador do usuário name: 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: Identificando usuário bloqueado recPapel: description: type: object required: – idPapel – nome properties: idPapel: type: string description: Identificador do Papel nome: type: string description: Nome do Papel descricao: type: string description: Descrição do Papel userInfo: description: type: object required: – idUsuario – nome – nomeCompleto – email – bloqueado – papeis – userNameDomain properties: idUsuario: type: string description: Id do usuário nome: type: string description: Nome (username) do usuário nomeCompleto: type: string description: Nome completo do usuário email: type: string description: Contém o endereço de email do usuário descricao: type: string description: Descrição do usuário (valor opcional) bloqueado: type: boolean description: Indica se o usuário está bloqueado papeis: type: array items: type: object allOf: – #/definitions/recPapel minimum: 1 description: Todos os papéis que o usuário possui userNameDomain: type: string description: Nome com domínio (userName@domain) do usuário recRecurso: description: Representa um recurso com suas ações type: object required: – uriRecurso – acoesPermissao properties: uriRecurso: type: string description: Identificador do Recurso acoesPermissao: type: array items: type: string minimum: 1 description: Lista de ações que se quer verificar no recurso recRecursoPermissao: description: Representa um recurso com suas ações type: object required: – uriRecurso – acoesPermissao properties: uriRecurso: type: string description: Identificador do Recurso acoesPermissao: type: array items: type: object allOf: – #/definitions/permissaoAcao minimum: 1 description: Ações com sua permissão permissaoAcao: description: Representa uma ação e o resultado de sua permissão type: object required: – nomeAcao – permitido – filtrosCustomizados – filtros properties: nomeAcao: type: string description: Identificador da Ação permitido: type: boolean description: Valor para a permissão filtrosCustomizados: type: array items: type: string minimum: 1 description: lista com as URIS dos filtros customizados que estão ativos para este usuário/recurso/ação filtros: type: array items: type: string minimum: 1 description: lista com expressões json contendo os filtros de dados ativos para este usuário/recurso/ação basicUser: description: [DESCONTINUADO] Dados do usuário alterado type: object required: – username – blocked properties: username: type: string description: Nome do usuário blocked: type: boolean description: Se o usuário está bloqueado changedUser: description: Dados do usuário alterado 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 includedUser: description: Dados do usuário incluído type: object required: – username properties: username: type: string description: Nome do usuário, com domínio ( usuário @ dominio.com ) papeis: type: array items: type: string description: Papeis atribuídos na importação/inclusão Papel: description: Representa um papel de usuário type: object required: – idPapel – nome properties: idPapel: type: string description: Identificador do Papel nome: type: string description: Nome do Papel descricao: type: string description: Descrição do Papel Usuario: description: Representa um usuário type: object required: – idUsuario – nome – nomeCompleto – email – bloqueado properties: idUsuario: type: string description: Identificador do Usuário nome: type: string description: Nome do Usuário (username) nomeCompleto: type: string description: Nome completo do Usuário descricao: type: string description: Descrição do Usuário email: type: string description: Endereço de email do usuário bloqueado: type: boolean description: Indica se o usuário está bloqueado Grupo: description: Representa um grupo de usuário type: object required: – idGrupo – nome properties: idGrupo: type: string description: Identificador do Grupo nome: type: string description: Nome do Grupo descricao: type: string description: Descrição do Grupo email: type: string description: Email do grupo notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service 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

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação