usuarios

userManager

730 views 09/07/2019 10/05/2021 integrador 0

2.0info: 27.3.2 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/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 parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: Lista um tenant específico – utilizado somente se a requisição for feita pelo tenant master responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: #/definitions/recTenantListaTenants 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 parameters: – name: tenant description: Lista um tenant específico – utilizado somente se a requisição for feita pelo tenant master in: query type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: #/definitions/recTenantListaTenants 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/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/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/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/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/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/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/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/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 altDomains: type: array items: type: string description: Domínios alternativos 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/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 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 altDomains: type: array items: type: string description: Domínios alternativos. Se o valor for um array vazio, removerá os domínios alternativos existentes. Este campo só será considerado quando chamado por um usuário de tenant master. 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/prepareTenantSchema: post: description: Prepara o schema de um tenant. Só funcionará com o header trusted. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Nome do tenant que será feita a preparação do schema responses: 200: description: Ok schema: type: object 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/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/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/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/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/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/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/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/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 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) alternativeDomains: type: array items: type: object allOf: #/definitions/recAlternativeDomain description: Dominios alternativos do tenant urlAfterLogoff: type: string description: URL para redirecionamento após a realização do logoff recTenantListaTenants: description: 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. DEPRECADO: Retornará null. sobrenomeAdmin: type: string description: Sobrenome do administrador. DEPRECADO: Retornará null. emailAdmin: type: string description: Email do administrador senhaTamanhoMinimo: type: integer format: int64 description: Quantidade mínima de caracteres da senha. DEPRECADO: Retornará null. senhaTamanhoMaximo: type: integer format: int64 description: Quantidade máxima de caracteres da senha. DEPRECADO: Retornará null. senhaNumeros: type: boolean description: Indica se devem existir caracteres numéricos na senha. DEPRECADO: Retornará null. senhaMinusculas: type: boolean description: Indica se devem existir caracteres minúsculos na senha. DEPRECADO: Retornará null. senhaMaiusculas: type: boolean description: Indica se devem existir caracteres maiúsculos na senha. DEPRECADO: Retornará null. senhaEspeciais: type: boolean description: Indica se devem existir caracteres especiais na senha. DEPRECADO: Retornará null. applicationName: type: string description: O nome da aplicação desse tenant no API Manager. DEPRECADO: Retornará null. key: type: string description: chave de acesso ao portal, obtido no API Manager. DEPRECADO: Retornará null. secret: type: string description: segredo para acesso ao portal, obtido no API Manager. DEPRECADO: Retornará null. 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. DEPRECADO: Retornará null. default: false multiplosTokens: type: boolean description: Indica se para cada sessão do usuário deve ser gerado um novo token. DEPRECADO: Retornará null. assuntoEmailTrocaSenha: type: string description: Assunto do e-mail enviado ao usuário para a troca de senha. DEPRECADO: Retornará null. templateEmailTrocaSenha: type: string description: Texto do e-mail enviado ao usuário para a troca de senha. DEPRECADO: Retornará null. controleOrigemAcessoHabilitado: type: boolean description: Indica se o controle de origem de acesso está habilitado. DEPRECADO: Retornará null. faixasIpsValidos: type: array items: type: object allOf: #/definitions/recFaixaIpsValidos description: As faixas de IPs válidos para o controle de origem de acesso. DEPRECADO: Retornará null. servidorEmail: type: object allOf: #/definitions/recDadosConexaoEmail description: Dados para conexão ao servidor SMTP. DEPRECADO: Retornará null. servidorLDAP: type: object allOf: #/definitions/recDadosConexaoLDAP description: Dados para conexão ao servidor LDAP. DEPRECADO: Retornará null. servidorSAML: type: object allOf: #/definitions/recDadosConexaoSAML description: Dados para conexão ao servidor SAML. DEPRECADO: Retornará null. 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). DEPRECADO: Retornará null. alternativeDomains: type: array items: type: object allOf: #/definitions/recAlternativeDomain description: Dominios alternativos do tenant. DEPRECADO: Retornará null. urlAfterLogoff: type: string description: URL para redirecionamento após a realização do logoff. DEPRECADO: Retornará null. smtpServer: type: string description: Servidor SMTP. DEPRECADO: Retornará null. smtpPort: type: integer format: int64 description: Porta do servidor SMTP. DEPRECADO: Retornará null. smtpUser: type: string description: Usuário do servidor SMTP. DEPRECADO: Retornará null. smtpPassword: type: string description: Senha do usuário do servidor SMTP. DEPRECADO: Retornará null. requiresAuthentication: type: boolean description: Indíca se a autenticação é necessária ou não. DEPRECADO: Retornará null. sslEnabled: type: boolean description: SSL habilitado. DEPRECADO: Retornará null. tlsEnabled: type: boolean description: TSL habilitado. DEPRECADO: Retornará null. replicationYieldThreshold: type: integer format: int64 description: Número de usuários limite a serem replicados antes da thread conceder lugar para outras executarem. DEPRECADO: Retornará null. adminPassword: type: string description: Senha do admin do tenant – esse campo somente terá valor se a requisição for feita com trusted e pelo tenant master, e tenha partido do serviço de tenant. DEPRECADO: Retornará null. secret: true type: integer format: int64 description: Versão do último update feito através de eventos do tenant-service. DEPRECADO: Retornará null. rememberMeEnabled: type: boolean description: Permite que o usuário ative a opção de Lembrar Me no login. DEPRECADO: Retornará null. 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. DEPRECADO: Retornará null. 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. DEPRECADO: Retornará null. defaultRoles: type: array items: type: string description: Papéis padrões do tenant. DEPRECADO: Retornará null. recAlternativeDomain: description: Dominio alternativo do tenant type: object required: – id – domainName properties: id: type: string description: Identificador do dominio alternativo domainName: type: string description: Nome do dominio alternativo 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 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 recDadosConexaoSAML: description: Representa os dados de conexão a um servidor SAML type: object required: – identityProviderEntityId – serviceProviderEntityId – redirectURL – loginURL properties: 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 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` 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 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 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 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