Usuarios

userManager

203 views 09/07/2019 12/11/2019 integrador 0

2.0info: 20.3.0 userManager x-senior-domain: usuarios x-senior-domain-path: usuarios x-senior-service-path: userManager contact: name: Senior X Platform url: http://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/isSamlAuthentication: post: description: Retorna se está sendo utilizado autenticação SAML para um determinado tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: O domínio do tenant responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Se o tenant utiliza autenticação SAML default: description: Error response schema: #/definitions/genericError get: description: Retorna se está sendo utilizado autenticação SAML para um determinado tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: tenantDomain description: O domínio do tenant in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Se o tenant utiliza autenticação SAML default: description: Error response schema: #/definitions/genericError /userManager/queries/obterMeusDados: post: description: 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 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 default: description: Error response schema: #/definitions/genericError get: description: 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 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 default: description: Error response schema: #/definitions/genericError /userManager/queries/listUsers: post: description: Lista os usuários de forma paginada, permitindo ordenar e filtrar pelos campos nome, nomeCompleto e email. tags: – Queries 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 default: description: Error response schema: #/definitions/genericError get: description: Lista os usuários de forma paginada, permitindo ordenar e filtrar pelos campos nome, nomeCompleto e email. tags: – Queries 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 default: description: Error response schema: #/definitions/genericError /userManager/queries/obterDadosUsuario: post: description: Retorna as informações básicas do usuário passado como parâmetro. tags: – Queries 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 default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do usuário passado como parâmetro. tags: – Queries 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 default: description: Error response schema: #/definitions/genericError /userManager/queries/listaLocalidades: post: description: Retorna lista com localidades para internacionalização tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – localidades properties: localidades: type: array items: type: object allOf: #/definitions/recLocalidade minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Retorna lista com localidades para internacionalização tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – localidades properties: localidades: type: array items: type: object allOf: #/definitions/recLocalidade minimum: 1 description: default: description: Error response schema: #/definitions/genericError /userManager/queries/obtemRecursoAcoes: post: description: Retorna um recurso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – uriRecurso properties: uriRecurso: type: string description: URI do recurso responses: 200: description: Ok schema: type: object properties: recurso: type: object allOf: #/definitions/RecursoPermissao description: Recurso default: description: Error response schema: #/definitions/genericError get: description: Retorna um recurso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: uriRecurso description: URI do recurso in: query required: true type: string responses: 200: description: Ok schema: type: object properties: recurso: type: object allOf: #/definitions/RecursoPermissao description: Recurso default: description: Error response schema: #/definitions/genericError /userManager/queries/getUsersById: post: description: Buscar informações dos usuários através do campo identificador (id) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – users properties: users: type: array items: type: string minimum: 1 description: Identificadores dos usuários tenantName: type: string description: Nome do tenant que deseja-se obter os usuários responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: object allOf: #/definitions/Usuario minimum: 1 description: Informações dos usuários default: description: Error response schema: #/definitions/genericError get: description: Buscar informações dos usuários através do campo identificador (id) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: users description: Identificadores dos usuários in: query required: true type: array items: type: string minimum: 1 – name: tenantName description: Nome do tenant que deseja-se obter os usuários in: query type: string responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: object allOf: #/definitions/Usuario minimum: 1 description: Informações dos usuários default: description: Error response schema: #/definitions/genericError /userManager/queries/getUsersByName: post: description: Buscar informações dos usuários através do campo nome tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – users properties: users: type: array items: type: string minimum: 1 description: Nome dos usuários tenantName: type: string description: Nome do tenant que deseja-se obter os usuários responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: object allOf: #/definitions/Usuario minimum: 1 description: Informações dos usuários default: description: Error response schema: #/definitions/genericError get: description: Buscar informações dos usuários através do campo nome tags: – Queries x-senior-visibility: PUBLIC parameters: – name: users description: Nome dos usuários in: query required: true type: array items: type: string minimum: 1 – name: tenantName description: Nome do tenant que deseja-se obter os usuários in: query type: string responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: object allOf: #/definitions/Usuario minimum: 1 description: Informações dos usuários default: description: Error response schema: #/definitions/genericError /userManager/queries/listaTenants: post: description: Lista todos os tenants cadastrados tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: #/definitions/recTenant minimum: 1 description: Lista com os dados de todos os tenants cadastrados default: description: Error response schema: #/definitions/genericError get: description: Lista todos os tenants cadastrados tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: #/definitions/recTenant minimum: 1 description: Lista com os dados de todos os tenants cadastrados default: description: Error response schema: #/definitions/genericError /userManager/queries/getTenant: post: description: Busca informações sobre o tenant do contexto. Informações de LDAP estão restritas ao serviço de autorização tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: type: object allOf: #/definitions/recTenant description: Informações sobre o tenant defaultRoles: type: array items: type: string description: Papeis padrão configurando para o tenant default: description: Error response schema: #/definitions/genericError get: description: Busca informações sobre o tenant do contexto. Informações de LDAP estão restritas ao serviço de autorização tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: type: object allOf: #/definitions/recTenant description: Informações sobre o tenant defaultRoles: type: array items: type: string description: Papeis padrão configurando para o tenant default: description: Error response schema: #/definitions/genericError /userManager/queries/listaUsuariosTenant: post: description: Lista todos os usuarios do tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeTenant properties: nomeTenant: type: string description: responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: #/definitions/userInfo minimum: 1 description: Lista com os dados de todos os usuários cadastrados no tenant default: description: Error response schema: #/definitions/genericError get: description: Lista todos os usuarios do tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: nomeTenant description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: #/definitions/userInfo minimum: 1 description: Lista com os dados de todos os usuários cadastrados no tenant default: description: Error response schema: #/definitions/genericError /userManager/queries/obtemUsuarioPeloNome: post: description: Obtém um usuário pelo nome. tags: – Queries 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. default: description: Error response schema: #/definitions/genericError get: description: Obtém um usuário pelo nome. tags: – Queries 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. default: description: Error response schema: #/definitions/genericError /userManager/queries/obtemUrlTelaRedefinicaoSenha: post: description: Obtém a url da tela de redefinição de senha que foi configurada para o tenant. É necessário informar o nome ou o domínio do tenant. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: nomeTenant: type: string description: Nome do tenant. dominioTenant: type: string description: Domínio do tenant. responses: 200: description: Ok schema: type: object required: – permitirRedefinirSenha properties: urlTelaRedefinicaoSenha: type: string description: Url da tela de redefinição de senha que foi configurada para o tenant. permitirRedefinirSenha: type: boolean description: Informa se deve permitir redefinir a senha. default: description: Error response schema: #/definitions/genericError get: description: Obtém a url da tela de redefinição de senha que foi configurada para o tenant. É necessário informar o nome ou o domínio do tenant. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: nomeTenant description: Nome do tenant. in: query type: string – name: dominioTenant description: Domínio do tenant. in: query type: string responses: 200: description: Ok schema: type: object required: – permitirRedefinirSenha properties: urlTelaRedefinicaoSenha: type: string description: Url da tela de redefinição de senha que foi configurada para o tenant. permitirRedefinirSenha: type: boolean description: Informa se deve permitir redefinir a senha. default: description: Error response schema: #/definitions/genericError /userManager/queries/obtemUrlAposLogoff: post: description: Obtém a configuração do tenant da URL para onde o usuário deve ser redirecionado após o logoff tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – urlAposLogoff properties: urlAposLogoff: type: string description: URL para redirecionamento após a realização do Logoff default: description: Error response schema: #/definitions/genericError get: description: Obtém a configuração do tenant da URL para onde o usuário deve ser redirecionado após o logoff tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – urlAposLogoff properties: urlAposLogoff: type: string description: URL para redirecionamento após a realização do Logoff default: description: Error response schema: #/definitions/genericError /userManager/queries/obtemTipoAutenticacao: post: description: Obtém o tipo de autenticação utilizado no tenant corrente tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – tipoAutenticacao – permiteAlterarSenha – permiteAlterarSenhaAposAutenticar properties: tipoAutenticacao: type: integer format: int64 description: Contém o tipo de autenticação utilizado pelo tenant permiteAlterarSenha: type: boolean description: Indica se o tipo de autenticação do tenant permite que os usuários alterem a senha. permiteAlterarSenhaAposAutenticar: type: boolean description: Indica se novos usuários do tenant devem vir com o opção para alterar a senha após efetuar o primeiro login ativa por padrão. Mesmo com essa opção ativa o admin no cadastro de usuário poderá optar por não obrigar o usuário alterar a senha após realizar o login. default: description: Error response schema: #/definitions/genericError get: description: Obtém o tipo de autenticação utilizado no tenant corrente tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – tipoAutenticacao – permiteAlterarSenha – permiteAlterarSenhaAposAutenticar properties: tipoAutenticacao: type: integer format: int64 description: Contém o tipo de autenticação utilizado pelo tenant permiteAlterarSenha: type: boolean description: Indica se o tipo de autenticação do tenant permite que os usuários alterem a senha. permiteAlterarSenhaAposAutenticar: type: boolean description: Indica se novos usuários do tenant devem vir com o opção para alterar a senha após efetuar o primeiro login ativa por padrão. Mesmo com essa opção ativa o admin no cadastro de usuário poderá optar por não obrigar o usuário alterar a senha após realizar o login. default: description: Error response schema: #/definitions/genericError /userManager/queries/getAuthenticationTypes: post: description: Obtém o(s) tipo(s) de autenticação utilizado no tenant corrente tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object properties: authenticationTypes: type: array items: type: object allOf: #/definitions/authenticationTypes description: default: description: Error response schema: #/definitions/genericError get: description: Obtém o(s) tipo(s) de autenticação utilizado no tenant corrente tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object properties: authenticationTypes: type: array items: type: object allOf: #/definitions/authenticationTypes description: default: description: Error response schema: #/definitions/genericError /userManager/queries/getFotoUsuario: post: description: Obtém a foto (em Base64) do usuário informado como parâmetro tags: – Queries 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: – fotoUsuario properties: fotoUsuario: type: string description: Foto do usuário em base64 default: description: Error response schema: #/definitions/genericError get: description: Obtém a foto (em Base64) do usuário informado como parâmetro tags: – Queries 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: – fotoUsuario properties: fotoUsuario: type: string description: Foto do usuário em base64 default: description: Error response schema: #/definitions/genericError /userManager/queries/obtemFotoUsuario: post: description: DEPRECATED – dar preferência para o getFotoUsuario Obtém a foto do usuário informado como parâmetro tags: – Queries 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: – fotoUsuario properties: fotoUsuario: type: string format: byte description: Foto do usuário default: description: Error response schema: #/definitions/genericError get: description: DEPRECATED – dar preferência para o getFotoUsuario Obtém a foto do usuário informado como parâmetro tags: – Queries 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: – fotoUsuario properties: fotoUsuario: type: string format: byte description: Foto do usuário default: description: Error response schema: #/definitions/genericError /userManager/queries/obtemPropriedadesPapel: post: description: Retorna a lista de propriedades de um Papel tags: – Queries 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: – propriedades properties: propriedades: type: array items: type: object allOf: #/definitions/recPropriedade minimum: 1 description: Lista com as propriedades default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de propriedades de um Papel tags: – Queries 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: – propriedades properties: propriedades: type: array items: type: object allOf: #/definitions/recPropriedade minimum: 1 description: Lista com as propriedades default: description: Error response schema: #/definitions/genericError /userManager/queries/obtemPropriedadesUsuario: post: description: Retorna a lista de propriedades de um Usuário tags: – Queries 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: – propriedades properties: propriedades: type: array items: type: object allOf: #/definitions/recPropriedade minimum: 1 description: Lista com as propriedades default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de propriedades de um Usuário tags: – Queries 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: – propriedades properties: propriedades: type: array items: type: object allOf: #/definitions/recPropriedade minimum: 1 description: Lista com as propriedades default: description: Error response schema: #/definitions/genericError /userManager/queries/obtemPropriedadesRecurso: post: description: Retorna a lista de propriedades de um Recurso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idRecurso properties: idRecurso: type: string description: Identificador do recurso responses: 200: description: Ok schema: type: object required: – propriedades properties: propriedades: type: array items: type: object allOf: #/definitions/recPropriedade minimum: 1 description: Lista com as propriedades default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de propriedades de um Recurso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idRecurso description: Identificador do recurso in: query required: true type: string responses: 200: description: Ok schema: type: object required: – propriedades properties: propriedades: type: array items: type: object allOf: #/definitions/recPropriedade minimum: 1 description: Lista com as propriedades default: description: Error response schema: #/definitions/genericError /userManager/queries/listaUsuariosPapel: post: description: Lista os usuários que possuem um determinado papel tags: – Queries 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: string minimum: 1 description: Lista com os ids dos usuários que possuem o papel default: description: Error response schema: #/definitions/genericError get: description: Lista os usuários que possuem um determinado papel tags: – Queries 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: string minimum: 1 description: Lista com os ids dos usuários que possuem o papel default: description: Error response schema: #/definitions/genericError /userManager/queries/listaUsuariosCompletosPapel: post: description: Lista os informações completas dos usuários que possuem um determinado papel tags: – Queries 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 default: description: Error response schema: #/definitions/genericError get: description: Lista os informações completas dos usuários que possuem um determinado papel tags: – Queries 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 default: description: Error response schema: #/definitions/genericError /userManager/queries/listaPapeisUsuario: post: description: Lista os papéis de um usuário tags: – Queries 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 default: description: Error response schema: #/definitions/genericError get: description: Lista os papéis de um usuário tags: – Queries 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 default: description: Error response schema: #/definitions/genericError /userManager/queries/obtemPapeisUsuario: post: description: Lista os papeis do usuário que executou a primitiva (a partir do username do cabeçalho da mensagem) tags: – Queries 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 default: description: Error response schema: #/definitions/genericError get: description: Lista os papeis do usuário que executou a primitiva (a partir do username do cabeçalho da mensagem) tags: – Queries 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 default: description: Error response schema: #/definitions/genericError /userManager/queries/listaAcoesPapel: post: description: Lista as ações atribuídas a um papel tags: – Queries 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: – acoes properties: acoes: type: array items: type: object allOf: #/definitions/recAcao minimum: 1 description: Lista com os ids das ações atribuídas ao papel default: description: Error response schema: #/definitions/genericError get: description: Lista as ações atribuídas a um papel tags: – Queries 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: – acoes properties: acoes: type: array items: type: object allOf: #/definitions/recAcao minimum: 1 description: Lista com os ids das ações atribuídas ao papel default: description: Error response schema: #/definitions/genericError /userManager/queries/listaPapeisAcao: post: description: Lista os papéis que podem executar uma determinada ação tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idAcao properties: idAcao: type: string description: Identificador da ação 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 que podem executar a ação default: description: Error response schema: #/definitions/genericError get: description: Lista os papéis que podem executar uma determinada ação tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idAcao description: Identificador da ação 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 que podem executar a ação default: description: Error response schema: #/definitions/genericError /userManager/queries/listaDominios: post: description: Lista os domínios existentes tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dominios properties: dominios: type: array items: type: object allOf: #/definitions/recDominio minimum: 1 description: Lista com os domínios cadastrados default: description: Error response schema: #/definitions/genericError get: description: Lista os domínios existentes tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dominios properties: dominios: type: array items: type: object allOf: #/definitions/recDominio minimum: 1 description: Lista com os domínios cadastrados default: description: Error response schema: #/definitions/genericError /userManager/queries/listaRecursosAcoes: post: description: Obtém uma lista com todos os recursos e suas respectivas ações tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – recursosAcoes properties: recursosAcoes: type: array items: type: object allOf: #/definitions/recAcoesRecurso minimum: 1 description: Lista com os recursos e suas ações default: description: Error response schema: #/definitions/genericError get: description: Obtém uma lista com todos os recursos e suas respectivas ações tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – recursosAcoes properties: recursosAcoes: type: array items: type: object allOf: #/definitions/recAcoesRecurso minimum: 1 description: Lista com os recursos e suas ações default: description: Error response schema: #/definitions/genericError /userManager/queries/listaUsuarios: post: description: Obtém uma lista com os principais dados dos usuários tags: – Queries 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 default: description: Error response schema: #/definitions/genericError get: description: Obtém uma lista com os principais dados dos usuários tags: – Queries 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 default: description: Error response schema: #/definitions/genericError /userManager/queries/obtemFiltrosAcessoDados: post: description: Obtém uma lista com os filtros de acesso aos dados que um determinado usuário possui tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeUsuario – uriRecurso – nomeAcao properties: nomeUsuario: type: string description: Nome do usuário uriRecurso: type: string description: URI do recurso nomeAcao: type: string description: Nome ação responses: 200: description: Ok schema: type: object required: – filtrosCustomizados – filtros properties: filtrosCustomizados: type: array items: type: string minimum: 1 description: lista com as URIS dos filtros customizados que estão ativos para este usuário filtros: type: array items: type: string minimum: 1 description: lista com expressões json contendo os filtros de dados ativos para este usuário default: description: Error response schema: #/definitions/genericError get: description: Obtém uma lista com os filtros de acesso aos dados que um determinado usuário possui tags: – Queries x-senior-visibility: PUBLIC parameters: – name: nomeUsuario description: Nome do usuário in: query required: true type: string – name: uriRecurso description: URI do recurso in: query required: true type: string – name: nomeAcao description: Nome ação in: query required: true type: string responses: 200: description: Ok schema: type: object required: – filtrosCustomizados – filtros properties: filtrosCustomizados: type: array items: type: string minimum: 1 description: lista com as URIS dos filtros customizados que estão ativos para este usuário filtros: type: array items: type: string minimum: 1 description: lista com expressões json contendo os filtros de dados ativos para este usuário default: description: Error response schema: #/definitions/genericError /userManager/queries/verificaPermissaoFiltros: post: description: Verifica se o usuário tem permissão de acesso a um recurso e, se tiver, retorna os filtros que estão associados a este recurso/ação. Se não possuir permissão, os filtros vem com nulo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeUsuario – uriRecurso – nomeAcao – atributos properties: nomeUsuario: type: string description: Nome do usuário uriRecurso: type: string description: URI do recurso nomeAcao: type: string description: Nome ação atributos: type: array items: type: object allOf: #/definitions/recAtributo minimum: 1 description: Atributos responses: 200: description: Ok schema: type: object required: – permitido – filtrosCustomizados – filtros properties: permitido: type: boolean description: Indica se pode ou não acessar o recurso passado como parâmetro filtrosCustomizados: type: array items: type: string minimum: 1 description: lista com as URIS dos filtros customizados que estão ativos para este usuário filtros: type: array items: type: string minimum: 1 description: lista com expressões json contendo os filtros de dados ativos para este usuário default: description: Error response schema: #/definitions/genericError /userManager/queries/verificaPermissoesFiltros: post: description: Verifica se o usuário tem permissão de acesso a um recurso e, se tiver, retorna os filtros que estão associados a este recurso/ação. Se não possuir permissão, os filtros vem com nulo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeUsuario – items properties: nomeUsuario: type: string description: Nome do usuário items: type: array items: type: object allOf: #/definitions/recItemPermissao minimum: 1 description: lista com os itens que serão validados responses: 200: description: Ok schema: type: object required: – permissoes properties: permissoes: type: array items: type: object allOf: #/definitions/recPermissaoFiltros minimum: 1 description: Lista com as permissões de acesso e filtros, para cada recurso passado como parâmetro default: description: Error response schema: #/definitions/genericError /userManager/queries/listaGrupos: post: description: Obtém uma lista com os principais dados dos grupos tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – grupos properties: grupos: type: array items: type: object allOf: #/definitions/recGrupo minimum: 1 description: Lista com todos os grupos default: description: Error response schema: #/definitions/genericError get: description: Obtém uma lista com os principais dados dos grupos tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – grupos properties: grupos: type: array items: type: object allOf: #/definitions/recGrupo minimum: 1 description: Lista com todos os grupos default: description: Error response schema: #/definitions/genericError /userManager/queries/listaGruposUsuario: post: description: Lista os grupos de um usuário tags: – Queries 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: – grupos properties: grupos: type: array items: type: object allOf: #/definitions/recGrupo minimum: 1 description: Lista com os ids dos papéis associados ao usuário default: description: Error response schema: #/definitions/genericError get: description: Lista os grupos de um usuário tags: – Queries 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: – grupos properties: grupos: type: array items: type: object allOf: #/definitions/recGrupo minimum: 1 description: Lista com os ids dos papéis associados ao usuário default: description: Error response schema: #/definitions/genericError /userManager/queries/listaUsuariosGrupo: post: description: Lista os usuários que possuem um determinado grupo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeGrupo properties: nomeGrupo: type: string description: Nome do Grupo responses: 200: description: Ok schema: type: object required: – usuarios properties: usuarios: type: array items: type: object allOf: #/definitions/userInfo minimum: 1 description: Lista com os usuários que possuem o grupo default: description: Error response schema: #/definitions/genericError get: description: Lista os usuários que possuem um determinado grupo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: nomeGrupo description: Nome do Grupo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – usuarios properties: usuarios: type: array items: type: object allOf: #/definitions/userInfo minimum: 1 description: Lista com os usuários que possuem o grupo default: description: Error response schema: #/definitions/genericError /userManager/queries/listaUsuariosRecurso: post: description: Lista os usuários que possuem permissão paro o recurso e ações passadas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – uriRecurso – acao properties: uriRecurso: type: string description: URI do recurso acao: type: string description: Ação para o recurso 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 usuários que tem acesso ao recurso default: description: Error response schema: #/definitions/genericError get: description: Lista os usuários que possuem permissão paro o recurso e ações passadas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: uriRecurso description: URI do recurso in: query required: true type: string – name: acao description: Ação para o recurso 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 usuários que tem acesso ao recurso default: description: Error response schema: #/definitions/genericError /userManager/queries/listAvailableTiers: post: description: Lista os Tiers disponíveis no WSO2 tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – tiers properties: tiers: type: array items: type: object allOf: #/definitions/tier minimum: 1 description: Lista com os tiers disponíveis no WSO2 default: description: Error response schema: #/definitions/genericError get: description: Lista os Tiers disponíveis no WSO2 tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – tiers properties: tiers: type: array items: type: object allOf: #/definitions/tier minimum: 1 description: Lista com os tiers disponíveis no WSO2 default: description: Error response schema: #/definitions/genericError /userManager/queries/getServicesWithFilters: post: description: Lista os serviços que possuem exatamente os mesmos campos de filtro informados no parâmetro. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fields properties: fields: type: array items: type: object allOf: #/definitions/filterField minimum: 1 description: Lista com os campos que os serviços devem possuir para serem retornados responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: #/definitions/serviceDomain minimum: 1 description: Lista com os serviços que possuem os mesmos campos de filtro que foram informados. 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: 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: 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: PUBLIC 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 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: PUBLIC 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/atualizaMeusDados: post: description: Altera as informações básicas do usuário que chamou a mensagem tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nome – nomeCompleto – descricao – email properties: 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: Idioma preferêncial do usuário foto: type: string description: Foto do usuário em Base64 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. default: description: Error response schema: #/definitions/genericError /userManager/actions/solicitaTrocaSenha: post: description: Envia um email para o usuário, com as instruções para troca de senha tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeUsuario – urlBase properties: nomeUsuario: type: string description: Nome do usuário, no formato nome@dominio_tenant, por exemplo: joao@senior.com.br urlBase: type: string description: Endereço base da página de troca de senha, que será enviado ao usuário via email 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 recipient: type: string description: Endereço de e-mail para qual foi enviado as instruções de troca de senha default: description: Error response schema: #/definitions/genericError /userManager/actions/precadastraUsuario: post: description: Pré-cadastra um usuário na base, com base no email passado como parâmetro. O usuário é inserido, mas não é visível para nenhuma parte do sistema até que o cadastro seja confirmado. Utilizado pelas rotinas do Senior Digital para inclusão de novos usuários através de convites. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – email properties: email: type: string description: Endereço de e-mail do novo usuário responses: 200: description: Ok schema: type: object required: – idUsuario – nome properties: idUsuario: type: string description: Identificador do usuário pré-cadastrado nome: type: string description: Nome (username) do usuário default: description: Error response schema: #/definitions/genericError /userManager/actions/ativaUsuarioPreCadastrado: post: description: Ativa um usuário que estava pré-cadastrado no sistema. Utilizado pelas rotinas do Senior Digital para adicionar usuários através de convites tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idUsuario – nome – nomeCompleto – senha – confirmacaoSenha – papeis properties: idUsuario: type: string description: Identificador do usuário pré-cadastrado nome: type: string description: Nome (username) do usuário nomeCompleto: type: string description: Nome completo do usuário senha: type: string description: Senha do usuário confirmacaoSenha: type: string description: Confirmação da senha do usuário descricao: type: string description: Descrição do usuário (opcional) papeis: type: array items: type: string minimum: 1 description: Lista com os identificadores dos papéis associados a este usuário responses: 200: description: Ok schema: type: object required: – idUsuario properties: idUsuario: type: string description: Identificador do usuário recém ativado default: description: Error response schema: #/definitions/genericError /userManager/actions/trocaSenhaComToken: post: description: Faz a troca da senha do usuário, autorizada através do token passado tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – token – nomeUsuario – novaSenha properties: token: type: string description: Token enviado para o usuário via email, através da ação solicitaTrocaSenha nomeUsuario: type: string description: Nome do usuário novaSenha: 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 schema: type: object required: – trocaOk properties: trocaOk: type: boolean description: Retorna um boolean indicando se a troca foi efetuada com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/insereRecursoAcoes: post: description: Insere um recurso e suas respectivas ações tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeDominio – nomeServico – nomeRecurso – descricaoRecurso – URIRecurso – listaAcoes properties: nomeDominio: type: string description: Nome do domínio do recurso nomeServico: type: string description: Nome do serviço do recurso nomeRecurso: type: string description: Nome do recurso rotuloRecurso: type: string description: Rótulo do recurso descricaoRecurso: type: string description: Descrição do recurso URIRecurso: type: string description: URI do recurso master: type: boolean description: Indica se o recurso é master listaAcoes: type: array items: type: string minimum: 1 description: Lista com as ações que este recurso possui. Por exemplo: Visualizar, Executar, etc.. responses: 200: description: Ok schema: type: object required: – idRecurso properties: idRecurso: type: string description: O identificador do recurso recém criado default: description: Error response schema: #/definitions/genericError /userManager/actions/removeRecursoAcoes: post: description: Remove um recurso e suas respectivas ações tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – uriRecurso properties: uriRecurso: type: string description: URI do recurso responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Status da operação default: description: Error response schema: #/definitions/genericError /userManager/actions/removeRecursoAcoesPorId: post: description: Remove um recurso e suas respectivas ações tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idRecurso properties: idRecurso: type: string description: Identificador do recurso responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Status da operação default: description: Error response schema: #/definitions/genericError /userManager/actions/createTenant: post: description: Cria um tenant com o mínimo de informação necessária tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – name – domain – adminInformation properties: name: type: string maxLength: 32 description: O nome do tenant, suportando apenas caracteres e números domain: type: string maxLength: 32 description: O domínio do tenant utilizando o formato de namespace: hcm.senior.com.br, tenant1.com.br adminInformation: type: object allOf: #/definitions/advancedAdminInformation description: As informações do administrador do tenant necessárias na criação notificationEmail: type: object allOf: #/definitions/notificationEmail description: O conteúdo do e-mail que será enviado para o e-mail do administrador informando que o tenant foi criado com sucesso responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do tenant recém-criado default: description: Error response schema: #/definitions/genericError /userManager/actions/configureTenantWSO2Settings: post: description: Realiza no WSO2 as configurações necessárias para as assinaturas, de acordo com o tier selecionado tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: O domínio do tenant tier: type: string description: O nível do Tier configurado para o Tenant. Se não definido, será considerado Unlimited applicationName: type: string description: O nome da aplicação para as assinaturas das APIs. Se não definido, será considerado SeniorSistemas consumerKey: type: string description: A chave de acesso para as assinaturas das APIs. Se não definido, será tentado a geração automática dessas informações para o tenant. consumerSecret: type: string description: O segredo de acesso para as assinaturas das APIs. Se não definido, será tentado a geração automática dessas informações para o tenant. responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indicador se a configuração foi efetuada com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/configureTenantReplicationSettings: post: description: Realiza as configurações de replicação para o tenant selecionado tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: O domínio do tenant replicationYieldThreshold: type: integer format: int64 description: O número de usuários limite a serem replicados antes da thread conceder lugar para outras executarem responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indicador se a configuração foi efetuada com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/configureTenantOriginAccessControlSettings: post: description: Altera as configurações de controle de acesso de um tenant tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain – enableOriginAccessControl – trustedIpAddressesRanges properties: tenantDomain: type: string description: Domínio do tenant que deve ter as configurações de controle de acesso alteradas enableOriginAccessControl: type: boolean description: Indica se o controle de origem de acesso está habilitado trustedIpAddressesRanges: type: array items: type: object allOf: #/definitions/ipAddressRange minimum: 1 description: Faixas de endereços IP válidos para o controle de origem de acesso responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indicador se a configuração foi efetuada com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/configureTenantEmailSettings: post: description: Altera as configurações de email de um tenant tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: Domínio do tenant que deve ter as configurações de e-mail alteradas smtpServer: type: string description: Servidor SMTP smtpPort: type: integer format: int64 description: Porta do servidor SMTP user: type: string description: Usuário do servidor SMTP password: type: string description: Senha do usuário do servidor SMTP requiresAuthentication: type: boolean description: Indica se a autenticação é necessária ou não sslEnabled: type: boolean description: SSL habilitado tlsEnabled: type: boolean description: TLS habilitado responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indicador se a configuração foi efetuada com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/configureTenantAuthenticationSettings: post: description: Altera as configurações de autenticação de um tenant tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: Domínio do tenant que deve ter as configurações de e-mail alteradas authenticationType: type: string allOf: – #/definitions/authType description: Tipo de autenticação utilizada pelo tenant authenticationTypes: type: array items: type: string allOf: – #/definitions/authType description: Tipos de autenticação suportados pelo tenant tokenByUserSession: type: boolean description: Indica se para cada sessão do usuário deve ser gerado um novo token default: false rememberMeEnabled: type: boolean description: Permite que o usuário ative a opção de Lembrar Me no login default: false rememberMeDuration: type: integer format: int64 description: Tempo de duração do cookie (em horas) ao marcar a opção Lembrar Me na tela de login default: 0 canChangePassword: type: boolean description: Indica se o tenant permite que os usuários alterem a senha pela plataforma quando o tipo de autenticação é G5. Se permitir, o usuário poderá alterar a sua senha pela plataforma e passará a utilizar essa senha no login da G7. Porém, a senha no SGU não será alterada, continuará a antiga. Se a senha do SGU for alterada após o usuário alterar na G7, passará a valer a senha do SGU novamente. default: false newUsersNeedChangePasswordAfterLogin: type: boolean description: Indica se novos usuários do tenant devem vir com o opção para alterar a senha após efetuar o primeiro login ativa por padrão. Mesmo com essa opção ativa o admin no cadastro de usuário poderá optar por não obrigar o usuário alterar a senha após realizar o login. default: false responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indicador se a configuração foi efetuada com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/configureTenantLDAPSettings: post: description: Cria uma nova conexão LDAP tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain – servidorLDAP properties: tenantDomain: type: string description: tenant para configurar LDAP servidorLDAP: type: object allOf: #/definitions/recDadosConexaoLDAP description: Dados para conexão ao servidor LDAP responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indicador se a configuração foi efetuada com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/configureTenantPasswordPolicySettings: post: description: Configura politica de senha do tenant tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain – minimumLengthPassword – maximumLengthPassword – passwordNumbers – lowercasePassword – uppercasePassword – specialCharacters – changePasswordEmailTemplate – changePasswordEmailSubject properties: tenantDomain: type: string description: tenant para configurar politica de senha minimumLengthPassword: type: integer format: int64 description: Quantidade mínima de caracteres da senha maximumLengthPassword: type: integer format: int64 description: Quantidade máxima de caracteres da senha passwordNumbers: type: boolean description: Indica se devem existir caracteres numéricos na senha lowercasePassword: type: boolean description: Indica se devem existir caracteres minúsculos na senha uppercasePassword: type: boolean description: Indica se devem existir caracteres maiúsculos na senha specialCharacters: type: boolean description: Indica se devem existir caracteres especiais na senha changePasswordEmailTemplate: type: string description: Texto do e-mail enviado ao usuário para a troca de senha. changePasswordEmailSubject: type: string description: Assunto do e-mail enviado ao usuário para a troca de senha. changePasswordUrlReset: type: string description: Url da tela de redefinição de senha. Se não for informado, irá utilizar a tela padrão da plataforma. responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indicador se a configuração foi efetuada com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/configureTenantAuthenticationDefaultRolesSettings: post: description: Cria a associação de Default Roles ao Tenant Authentication LDAP e/ou SAML tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: O domínio do tenant utilizando o formato de namespace: hcm.senior.com.br, tenant1.com.br defaultRoles: type: array items: type: string description: Papeis em que os novos usuários devem ser cadastrados ao utilizar autenticação responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indicador se a configuração foi efetuada com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/configureTenantSAMLSettings: post: description: Cria uma nova conexão SAML tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain – identityProviderEntityId – serviceProviderEntityId – redirectURL – loginURL properties: tenantDomain: type: string description: O domínio do tenant utilizando o formato de namespace: hcm.senior.com.br, tenant1.com.br identityProviderEntityId: type: string description: Id da entidade do Identity Provider serviceProviderEntityId: type: string description: Id da entidade do Service Provider redirectURL: type: string description: URL de redirecionamento a ser utilizada pela requisição SAML loginURL: type: string description: URL do servidor SAML para realizar o login logoffURL: type: string description: URL do servidor SAML para realizar o logoff claimUsername: type: string description: Claim que define o username do usuário claimEmail: type: string description: Claim que define o email do usuário claimName: type: string description: Claim que define o nome do usuário useClaimUsername: type: boolean description: Define se a claim username será utilizada para definir o usuário responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indicador se a configuração foi efetuada com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/configureTenantGeneralSettings: post: description: Configura os dados gerais do tenant tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: O domínio do tenant utilizando o formato de namespace: hcm.senior.com.br, tenant1.com.br locale: type: string description: Localidade do tenant ex: pt-BR urlAfterLogoff: type: string description: URL para redirecionamento após a realização do Logoff adminInformation: type: object allOf: #/definitions/adminInformation description: As informações do administrador do tenant responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indicador se a configuração foi efetuada com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/removeTenant: post: description: Remove tenant da base e do api manager tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: O domínio do tenant a ser removido utilizando o formato de namespace: hcm.senior.com.br, tenant1.com.br responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Boolean indicando se a remoção do tenant foi efetuada com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/sincronizaUsuariosLDAP: post: description: Efetua a sincronização dos usuários entre o servidor LDAP e a base local tags: – Actions 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/duplicaPapel: post: description: Duplica um papel já existente tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapelOrigem – nomePapel properties: idPapelOrigem: type: string description: Identificador do papel origem nomePapel: type: string description: Nome do novo papel descricaoPapel: type: string description: Descrição do novo papel responses: 200: description: Ok schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do papel recém-criado default: description: Error response schema: #/definitions/genericError /userManager/actions/desativaTenant: post: description: Desativa o tenant passado como parâmetro tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeTenant properties: nomeTenant: type: string description: Nome do tenant responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um boolean informando se o tenant foi desativado com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/ativaTenant: post: description: Ativa o tenant passado como parâmetro tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeTenant properties: nomeTenant: type: string description: Nome do tenant responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um boolean informando se o tenant foi ativado com sucesso default: description: Error response schema: #/definitions/genericError /userManager/actions/enviaFotoUsuario: post: description: Envia a foto do usuário para o servidor. A foto deverá ser enviada no formato Base64. Caso já exista uma foto, ela será substituída pela foto enviada nesta chamada. Se não existir, será criada uma nova foto. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario – fotoUsuario properties: idUsuario: type: string description: Identificador do usuário fotoUsuario: type: string description: Foto 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/atribuiAcaoAoPapel: post: description: Permite a execução de uma ação por um papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel – idAcaoPermissao properties: idPapel: type: string description: Identificador do papel idAcaoPermissao: type: string description: Identificador da ação 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/removeAcaoDoPapel: post: description: Revoga a permissão de uma ação para um Papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel – idAcaoPermissao properties: idPapel: type: string description: Identificador do Papel idAcaoPermissao: type: string description: Identificador da ação 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/verificaPermissao: post: description: Verifica se o usuário tem permissão para executar uma determinada ação em um recurso tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – uriRecurso – nomeAcao properties: nomeUsuario: type: string description: Nome do usuário. Se não for informado será utilizado o usuário da mensagem. uriRecurso: type: string description: URI do recurso nomeAcao: type: string description: Nome ação responses: 200: description: Ok schema: type: object required: – permitido properties: permitido: type: boolean description: True se o usuário pode executar a ação ou false se não pode default: description: Error response schema: #/definitions/genericError /userManager/actions/verificaPermissoesRecursos: post: description: Verifica permissões em várias ações para vários recursos tags: – Actions 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/verificaPermissaoAtributos: post: description: Verifica se o usuário tem permissão de executar uma determinada ação em um recurso e seus atributos tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeUsuario – uriRecurso – nomeAcao – atributos properties: nomeUsuario: type: string description: Nome do usuário uriRecurso: type: string description: URI do recurso nomeAcao: type: string description: Nome ação atributos: type: array items: type: object allOf: #/definitions/recAtributo minimum: 1 description: Atributos responses: 200: description: Ok schema: type: object required: – permitido properties: permitido: type: boolean description: True se o usuário pode executar a ação ou false se não pode default: description: Error response schema: #/definitions/genericError /userManager/actions/verificaPermissoes: post: description: Verifica se o usuário tem permissão para executar uma determinada ação em uma lista de recursos. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeAcao – recursos properties: nomeUsuario: type: string description: Nome do usuário. Se não for informado será utilizado o usuário da mensagem. nomeAcao: type: string description: Nome da ação que será verificada recursos: type: array items: type: string minimum: 1 description: Lista com as URIs dos recursos que serão validados responses: 200: description: Ok schema: type: object required: – permissoes properties: permissoes: type: array items: type: object allOf: #/definitions/recPermissao minimum: 1 description: Lista com as permissões relativas aos itens passados como parâmetro. É uma lista contendo o nome de cada recurso e um boolean, indicando se o recurso é permitido ou não default: description: Error response schema: #/definitions/genericError /userManager/actions/adicionaPropriedadePapel: post: description: Adiciona uma propriedade em um Papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel – nome – valor properties: idPapel: type: string description: Identificador do Papel nome: type: string description: Nome da propriedade valor: type: string description: Valor da propriedade 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/removePropriedadePapel: post: description: Remove uma propriedade de um Papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel – idPropriedade properties: idPapel: type: string description: Identificador do Papel idPropriedade: type: string description: identificador da Propriedade que será excluída 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/atualizaPropriedadePapel: post: description: Atualiza uma propriedade de um Papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel – idPropriedade – nome – valor properties: idPapel: type: string description: Identificador do Papel idPropriedade: type: string description: Identificador da propriedade nome: type: string description: Nome da propriedade valor: type: string description: Valor da propriedade 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/adicionaPropriedadeUsuario: post: description: Adiciona uma propriedade em um Usuário tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario – nome – valor properties: idUsuario: type: string description: Identificador do Usuário nome: type: string description: Nome da propriedade valor: type: string description: Valor da propriedade 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/removePropriedadeUsuario: post: description: Remove uma propriedade de um Usuário tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario – idPropriedade properties: idUsuario: type: string description: Identificador do Usuário idPropriedade: type: string description: identificador da Propriedade que será excluída 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/atualizaPropriedadeUsuario: post: description: Atualiza uma propriedade de um Usuário tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario – idPropriedade – nome – valor properties: idUsuario: type: string description: Identificador do Usuário idPropriedade: type: string description: Identificador da propriedade nome: type: string description: Nome da propriedade valor: type: string description: Valor da propriedade 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/adicionaPropriedadeRecurso: post: description: Adiciona uma propriedade em um Recurso tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idRecurso – nome – valor properties: idRecurso: type: string description: Identificador do Recurso nome: type: string description: Nome da propriedade valor: type: string description: Valor da propriedade 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/removePropriedadeRecurso: post: description: Remove uma propriedade de um Recurso tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idRecurso – idPropriedade properties: idRecurso: type: string description: Identificador do Recurso idPropriedade: type: string description: Identificador da Propriedade que será excluída 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/atualizaPropriedadeRecurso: post: description: Atualiza uma propriedade de um Recurso tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idRecurso – idPropriedade – nome – valor properties: idRecurso: type: string description: Identificador do Recurso idPropriedade: type: string description: Identificador da propriedade nome: type: string description: Nome da propriedade valor: type: string description: Valor da propriedade 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/adicionaPapelUsuario: post: description: Adiciona um papel a um usuário tags: – Actions 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/removePapelUsuario: post: description: 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 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/insereDominio: post: description: Cria um novo domínio para o tenant corrente tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeDominio – descricaoDominio properties: nomeDominio: type: string description: Nome do domínio rotuloDominio: type: string description: Rótulo do domínio descricaoDominio: type: string description: Descrição do domínio responses: 200: description: Ok schema: type: object required: – idDominio properties: idDominio: type: string description: Identificador do dominio recém-criado, ou nulo em caso de erro default: description: Error response schema: #/definitions/genericError /userManager/actions/insereServico: post: description: Cria um novo servico para o dominio passado como parâmetro tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idDominio – nomeServico – descricaoServico properties: idDominio: type: string description: Identificador do domínio nomeServico: type: string description: Nome do serviço rotuloServico: type: string description: Rótulo do serviço descricaoServico: type: string description: Descrição do serviço responses: 200: description: Ok schema: type: object required: – idServico properties: idServico: type: string description: Identificador do serviço recém-criado, ou nulo em caso de erro default: description: Error response schema: #/definitions/genericError /userManager/actions/atualizaSenha: post: description: Atualiza a senha de um usuário tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario – senhaAtual – novaSenha – confirmacaoNovaSenha properties: idUsuario: type: string description: Identificador do usuário senhaAtual: type: string description: Senha atual do usuário novaSenha: type: string description: Nova senha do usuário confirmacaoNovaSenha: type: string description: Confirmação de senha 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/adicionaGrupoUsuario: post: description: Adiciona um Grupo a um usuário tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario – idGrupo properties: idUsuario: type: string description: Identificador do Usuário idGrupo: type: string description: Identificador do Grupo 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 default: description: Error response schema: #/definitions/genericError /userManager/actions/removeGrupoUsuario: post: description: Remove o grupo de um usuário. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario – idGrupo properties: idUsuario: type: string description: Identificador do Usuário idGrupo: type: string description: Identificador do Grupo 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 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. 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. default: description: Error response schema: #/definitions/genericError /userManager/actions/configureSAMLUser: post: description: Configura um usuário para o tenant que utiliza tipo de autenticação SAML. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – accessToken properties: accessToken: type: string description: Token de acesso do usuário responses: 200: description: Ok schema: type: object required: – username properties: username: type: string description: Nome do usuário 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 default: description: Error response schema: #/definitions/genericError /userManager/signals/refreshTenantResourcesInformation: post: description: Atualiza as informações de recursos do tenant requisitando as informações de resource para todos os serviços disponíveis tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: O domínio do tenant utilizando o formato de namespace: hcm.senior.com.br, tenant1.com.br responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /userManager/signals/restartLDAPConnection: post: description: Reinicia a conexão LDAP. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: Domínio do tenant que deve ter a conexão LDAP reiniciada. responses: 202: description: Accepted 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. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /userManager/signals/replicateFilterValues: post: description: Replica os valores de campos de filtro (abrangência) de um papel e serviço para outros serviços. Caso existam outros valores configurados anteriormente nos serviços de destino esses valores serão apagados, ao final do processo todos os serviços de destino vão possuir exatamente os mesmos valores do serviço de origem para o papel informado. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – roleId – originServiceId – destinationServices properties: roleId: type: string description: Id do papel que possui os valores que devem ser replicadas para outros serviços. originServiceId: type: string description: Id do serviço que possui os valores que devem ser replicados para outros serviços. destinationServices: type: array items: type: string minimum: 1 description: Id dos serviços que devem ficar com os valores de campos de filtro (abrangência) iguais ao serviço e papel de origem. 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/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 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 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 responses: 200: description: Ok schema: type: array items: #/definitions/Papel 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 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 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 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 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 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 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 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 responses: 200: description: Ok schema: type: array items: #/definitions/Usuario 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 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 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 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 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 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 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 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 responses: 200: description: Ok schema: type: array items: #/definitions/Grupo 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 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 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 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 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 default: description: Error response schema: #/definitions/genericError definitions: eventType: description: Tipo de evento type: string enum: – PAPEL_INCLUIDO – PAPEL_EXCLUIDO – PAPEL_ALTERADO – PAPEL_ATRIBUIDO – PAPEL_REMOVIDO – PERMISSAO_INCLUIDA – PERMISSAO_EXCLUIDA provider: description: Tipos de provedores externos de autenticação type: string enum: – SAML authType: description: Tipo de autenticação do tenant type: string enum: – G7 – G5 – LDAP – SAML 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 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 adminInformation: description: As informações do administrador de um tenant discriminator: _discriminator type: object required: – email – _discriminator properties: email: type: string description: O email do usuário administrador firstName: type: string description: Nome do administrador. Se não definido, será considerado Administrador lastName: type: string description: Sobrenome do administrador. Se não definido, será considerado Sistema _discriminator: type: string description: advancedAdminInformation: description: As informações do administrador de um tenant, necessárias para criação de um tenant allOf: – #/definitions/adminInformation – type: object required: – password properties: password: type: string description: A senha do usuário administrador, com no mínimo 5 caracteres notificationEmail: description: O conteúdo do e-mail que será enviado para o e-mail do administrador informando que o tenant foi criado com sucesso type: object required: – subject – text – linkURL properties: subject: type: string description: O assunto do e-mail a ser enviado text: type: string description: Texto do e-mail a ser enviado. Ele pode conter as seguintes variáveis: ${link} – URL para acesso ao tenant criado, ${login} – o login do usuário administrador e ${senha} – a senha do usuário administrador linkURL: type: string description: A URL para acesso ao tenant criado authenticationTypes: description: Retorna os tipos de autenticação do tenant com detalhes type: object required: – type – allowsChangePassword – allowsChangePasswordAfterAuthentication properties: type: type: string allOf: – #/definitions/authType description: Contém o tipo de autenticação utilizado pelo tenant allowsChangePassword: type: boolean description: Indica se o tipo de autenticação permite que os usuários alterem a senha. allowsChangePasswordAfterAuthentication: type: boolean description: Indica se novos usuários do tenant devem vir com o opção para alterar a senha após efetuar o primeiro login ativa por padrão. Mesmo com essa opção ativa o admin no cadastro de usuário poderá optar por não obrigar o usuário alterar a senha após realizar o login. recTenant: description: Representa um tenant type: object required: – idTenant – dominioTenant – nome – locale – primeiroNomeAdmin – sobrenomeAdmin – emailAdmin – senhaTamanhoMinimo – senhaTamanhoMaximo – senhaNumeros – senhaMinusculas – senhaMaiusculas – senhaEspeciais – tipoAutenticacao – multiplosTokens – controleOrigemAcessoHabilitado – master properties: idTenant: type: string description: Identificador do tenant dominioTenant: type: string description: Domínio do tenant. De preferência utilize no formato de namespace: por exemplo: hcm.senior.com.br, tenant1.com.br, etc… nome: type: string description: Nome do tenant. Nome curto do tenant, sem espaços nem caracteres especiais. Por exemplo: HCM, Tenant1, ERP, etc.. locale: type: string description: Locale configurado para o tenant primeiroNomeAdmin: type: string description: Primeiro nome do administrador sobrenomeAdmin: type: string description: Sobrenome do administrador emailAdmin: type: string description: Email do administrador senhaTamanhoMinimo: type: integer format: int64 description: Quantidade mínima de caracteres da senha senhaTamanhoMaximo: type: integer format: int64 description: Quantidade máxima de caracteres da senha senhaNumeros: type: boolean description: Indica se devem existir caracteres numéricos na senha senhaMinusculas: type: boolean description: Indica se devem existir caracteres minúsculos na senha senhaMaiusculas: type: boolean description: Indica se devem existir caracteres maiúsculos na senha senhaEspeciais: type: boolean description: Indica se devem existir caracteres especiais na senha applicationName: type: string description: O nome da aplicação desse tenant no API Manager key: type: string description: chave de acesso ao portal, obtido no API Manager secret: type: string description: segredo para acesso ao portal, obtido no API Manager tipoAutenticacao: type: integer format: int64 description: Tipo de autenticação utilizada por este tenant (G5, G7, LDAP, etc..) authenticationTypes: type: array items: type: string allOf: – #/definitions/authType description: Tipos de autenticação disponíveis no tenant permiteAlterarSenhaG5: type: boolean description: Indica se o tenant permite que os usuários alterem a senha pela plataforma quando o tipo de autenticação é G5. Se permitir, o usuário poderá alterar a sua senha pela plataforma e passará a utilizar essa senha no login da G7. Porém, a senha no SGU não será alterada, continuará a antiga. Se a senha do SGU for alterada após o usuário alterar na G7, passará a valer a senha do SGU novamente. default: false multiplosTokens: type: boolean description: Indica se para cada sessão do usuário deve ser gerado um novo token assuntoEmailTrocaSenha: type: string description: Assunto do e-mail enviado ao usuário para a troca de senha. templateEmailTrocaSenha: type: string description: Texto do e-mail enviado ao usuário para a troca de senha. controleOrigemAcessoHabilitado: type: boolean description: Indica se o controle de origem de acesso está habilitado faixasIpsValidos: type: array items: type: object allOf: #/definitions/recFaixaIpsValidos description: As faixas de IPs válidos para o controle de origem de acesso servidorEmail: type: object allOf: #/definitions/recDadosConexaoEmail description: Dados para conexão ao servidor SMTP servidorLDAP: type: object allOf: #/definitions/recDadosConexaoLDAP description: Dados para conexão ao servidor LDAP master: type: boolean description: Indica se o tenant é master ativo: type: boolean description: Indica se o tenant está ativo subscriptionTier: type: string description: Nivel de inscrição do tenant (Valores válidos são listados pela primitiva usuarios.userManager.listAvailableTiers) recFaixaIpsValidos: description: Uma faixa de IPs válidos para o controle de origem de acesso type: object required: – valorInicial properties: valorInicial: type: string description: O valor inicial da faixa de IP valorFinal: type: string description: O valor final da faixa de IP ipAddressRange: description: Faixa de endereços IP type: object required: – startIpAddress properties: startIpAddress: type: string description: Endereço inicial da faixa de IPs endIpAddress: type: string description: Endereço final da faixa de IPs recDadosConexaoEmail: description: Representa os dados de conexão a um servidor SMTP type: object required: – host – port – user – password – requiresAuthentication – SSLTrustEnabled – TLSEnabled properties: host: type: string description: Nome do servidor de email port: type: string description: Porta IP do servidor de email user: type: string description: Usuário do servidor SMTP password: type: string description: Senha do usuário requiresAuthentication: type: boolean description: Indica se a autenticação é necessária ou não SSLTrustEnabled: type: boolean description: SSL Trust habilitado TLSEnabled: type: boolean description: TLS habilitado recDadosConexaoLDAP: description: Representa os dados para conexão ao um servidor LDAP type: object required: – host – port – SSLEnabled – user – password – searchBase – objectClass – userAttribute – usernameAttribute – descriptionAttribute – emailAttribute – userSearchFilter – userListFilter properties: host: type: string description: Nome do servidor LDAP port: type: integer format: int64 description: Porta IP do servidor LDAP SSLEnabled: type: boolean description: Indica se deve utilizar SSL para conexão user: type: string description: Usuário admin do servidor LDAP password: type: string description: Senha do usuário admin searchBase: type: string description: Endereço base para pesquisa dentro do servidor LDAP objectClass: type: string description: Nome do classe que representa um usuário, no LDAP userAttribute: type: string description: Nome do atributo que representa individualmente um usuário. Pode ser seu id, email, etc.. usernameAttribute: type: string description: Nome do atributo que contém o nome do usuário descriptionAttribute: type: string description: Nome do atributo que contém a descrição do usuário emailAttribute: type: string description: Nome do atributo que contém o email do usuário userSearchFilter: type: string description: Critério de pesquisa de usuários userListFilter: type: string description: Nome da classe que será retornada na pesquisa rolesSearchBase: type: string description: Endereço base para pesquisa de papéis no servidor LDAP rolesSearchFilter: type: string description: Filtro para pesquisa de papéis no servidor LDAP roleNameAttribute: type: string description: Nome do atributo que contém o nome do papel. O valor desse atributo no servidor LDAP precisa ser igual ao valor do atributo informado no campo `userMemberOfAttribute` roleDescriptionAttribute: type: string description: Nome do atributo que contém a descrição do papel userMemberOfAttribute: type: string description: Nome do attributo do usuário que contém os papéis a quais ele está associado. O valor desse atributo no servidor LDAP precisa ser igual ao valor do atributo informado no campo `roleNameAttribute` migrated: type: boolean description: Indicativo de autenticação LDAP gerenciada pelo serviço da Senior (quando falso, a autenticação com LDAP é gerenciada pelo Identity Server) recDominio: description: Representa um domínio type: object required: – idDominio – nome – rotulo – descricao properties: idDominio: type: string description: Identificador do domínio nome: type: string description: Nome do domínio rotulo: type: string description: Rótulo do domínio descricao: type: string description: Descrição do domínio recDominioFiltros: description: Representa um domínio e seus filtros type: object required: – idDominio – nome – descricao properties: idDominio: type: string description: Identificador do domínio nome: type: string description: Nome do domínio descricao: type: string description: Descrição do domínio filtrosCustomizados: type: array items: type: object allOf: #/definitions/recFiltroCustomizadoValor description: Lista com os filtros customizados deste domínio filtros: type: array items: type: object allOf: #/definitions/recFiltro description: Lista com os filtros simples deste domínio recDominioSimples: description: Representa um domínio e seus filtros, mas somente com os campos ids, sem os respectivos nomes type: object required: – idDominio properties: idDominio: type: string description: Identificador do domínio filtrosCustomizados: type: array items: type: object allOf: #/definitions/recFiltroCustomizadoSimples description: Lista com os filtros customizados deste domínio filtros: type: array items: type: object allOf: #/definitions/recFiltroSimples description: Lista com os filtros simples deste domínio recFiltroCustomizadoSimples: description: Representa um Filtro customizado, mas sem o nome e a URI, apenas o id e o indicador de ativo type: object required: – idFiltroCustomizado – checked properties: idFiltroCustomizado: type: string description: Identificador do filtro customizado checked: type: boolean description: Indica se este filtro está ativo ou não recFiltroSimples: description: Representa um filtro simples, mas somente com os ids type: object required: – idFiltro properties: idFiltro: type: string description: Identificador do filtro simples campos: type: array items: type: object allOf: #/definitions/recCampoFiltroSimples description: Lista com os campos definidos para este filtro simples recCampoFiltroSimples: description: Representa um campo de um filtro simples, mas somente com o seu respectivo id e valor type: object required: – idCampoFiltro – valorCampo properties: idCampoFiltro: type: string description: Identificador do campo do filtro simples valorCampo: type: string description: Valor cadastrado para o campo do filtro simples recPropriedade: description: Representa uma propriedade de um tenant/recurso/papel/usuário type: object required: – idPropriedade – nome – valor properties: idPropriedade: type: string description: Identificador da propriedade nome: type: string description: Nome da propriedade valor: type: string description: Valor da propriedade recAtributo: description: Representa um atributo de um recurso type: object required: – nome – valor properties: nome: type: string description: Nome do atributo valor: type: string description: Valor do atributo recPermissao: description: Representa uma permissão de acesso a um recurso type: object required: – nomeRecurso – permitido properties: nomeRecurso: type: string description: Nome do recurso permitido: type: boolean description: Indica se o acesso é permitido ou não recFiltroCustomizadoValor: description: Representa um filtro customizado type: object required: – idFiltroCustomizado – descricaoFiltroCustomizado – URIFiltroCustomizado – checked properties: idFiltroCustomizado: type: string description: Identificador do filtro descricaoFiltroCustomizado: type: string description: Descrição do filtro URIFiltroCustomizado: type: string description: URI única de identificação do filtro checked: type: boolean description: Indica se o filtro está ou não aplicado ao papel recFiltro: description: Representa um filtro simples type: object required: – idFiltro properties: idFiltro: type: string description: Identificador do filtro campos: type: array items: type: object allOf: #/definitions/recValorCampoFiltroDescricao description: Lista com os campos do filtro recValorCampoFiltroDescricao: description: Representa um campo de um filtro simples type: object required: – idCampoFiltro – nomeDisplayCampoFiltro – valorCampo properties: idCampoFiltro: type: string description: Identificador do campo nomeDisplayCampoFiltro: type: string description: Nome que será exibido do campo na tela valorCampo: type: string description: Valor a ser aplicado no filtro recAcao: description: Representa uma ação que é efetuada sobre um recurso type: object required: – idAcao – nomeAcao properties: idAcao: type: string description: Identificador da ação nomeAcao: type: string description: Nome da ação rotuloAcao: type: string description: Rótulo da ação recAcoesRecurso: description: Representa um recurso com suas respectivas ações type: object required: – idRecurso – nomeRecurso – nomeServico – acoes properties: idRecurso: type: string description: Identificador do recurso nomeRecurso: type: string description: Nome do recurso rotuloRecurso: type: string description: Rótulo do recurso nomeServico: type: string description: Nome do servico acoes: type: array items: type: object allOf: #/definitions/recAcao minimum: 1 description: Lista com as ações recItemPermissao: description: type: object required: – uriRecurso – nomeAcao – atributos properties: uriRecurso: type: string description: URI do recurso nomeAcao: type: string description: Nome ação atributos: type: array items: type: object allOf: #/definitions/recAtributo minimum: 1 description: Atributos recPermissaoFiltros: description: type: object required: – uriRecurso – acao – permitido – filtrosCustomizados – filtros properties: uriRecurso: type: string description: URI do recurso acao: type: string description: Ação permitido: type: boolean description: Indica se o recurso tem permissao de acesso 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 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 recLogLdap: description: type: object required: – idImportacao – idLog – dataInicioLog – descricaoLog – sucessoLog properties: idImportacao: type: string description: Identificador da importacao idLog: type: string description: Identificador do item do log dataInicioLog: type: string description: Data de início do item do log descricaoLog: type: string description: Descrição do item do log sucessoLog: type: boolean description: Operação finalizada com sucesso recLocalidade: description: type: object required: – codigo – descricao properties: codigo: type: string description: Identificador da localidade ex: pt_BR descricao: type: string description: Descrição da localidade ex: português (Brasil) recGrupo: description: 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 RecursoPermissao: description: Representa um recurso sobre o qual alguma ação será executada. Seu acesso deve ser autorizado através do uso das permissões type: object required: – idRecursoPermissao – nome – URI – acoes properties: idRecursoPermissao: type: string description: Identificador do Recurso nome: type: string description: Nome do Recurso. Por exemplo, ApuracaoPonto, Colaborador, NotaFiscal, etc.. rotulo: type: string description: Rótulo do Recurso. Por exemplo, Apuracao de ponto, Colaborador, Nota´fiscal, etc.. descricao: type: string description: Descrição do Recurso URI: type: string description: URI do recurso master: type: boolean description: Indica se o recurso é master acoes: type: array items: type: string minimum: 1 description: Lista com as ações associadas a este recurso AcaoPermissao: description: Representa uma ação que será executada em um recurso. Por exemplo, ação calcular no recurso folhaPagamento type: object required: – idAcaoPermissao – idRecursoPermissao – nome properties: idAcaoPermissao: type: string description: Identificador da Ação idRecursoPermissao: type: string description: Identificador do Recurso nome: type: string description: Nome da Ação. Por exemplo, Abrir, Alterar, Calcular, Imprimir, etc.. Normalmente é um verbo. rotulo: type: string description: Chave de trdução do rótulo da Ação. Por exemplo, usuarios.userManager.abrir_action, usuarios.userManager.calcular_action, usuarios.userManager.imprimir_action, etc.. 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 tier: description: Representa um tier do WSO2 type: object required: – name – description properties: name: type: string description: Nome do tier description: type: string description: Descrição do tier filterField: description: Campo de filtro de dados (abrangência) type: object required: – name – type properties: name: type: string description: Nome do campo type: type: string description: Tipo do campo de filtro serviceDomain: description: Dados de um serviço com o seu domínio type: object required: – serviceId – serviceName – domainId – domainName properties: serviceId: type: string description: Identificador do serviço serviceName: type: string description: Nome do serviço domainId: type: string description: Identificador do domínio domainName: type: string description: Nome do domínio 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