usuarios

web_interface

122 views 01/07/2019 18/06/2021 integrador 0

2.0info: 28.0.0 web_interface x-senior-domain: usuarios x-senior-domain-path: usuarios x-senior-service-path: web_interface 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: /web_interface/queries/listaTodosPapeis: post: description: Retorna uma lista com todos os papéis, respeitando a paginação e a ordenação passadas como parâmetro 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 deve ser exibida na grid com todos os papéis count: type: integer format: int64 description: Indica qual a quantidade de papéis é mostrada em cada página sort_by: type: string description: Nome do campo pelo qual os papéis são ordenados na grid sort_order: type: string description: Indica se a ordenação deve ser em ordem ASC ou DESC nome: type: string description: Nome utilizado como filtro responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: #/definitions/papelRec minimum: 1 description: Contém as linhas com os papéis pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os papéis, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Indica qual página deve ser exibida na grid com todos os papéis in: query type: integer format: int64 – name: count description: Indica qual a quantidade de papéis é mostrada em cada página in: query type: integer format: int64 – name: sort_by description: Nome do campo pelo qual os papéis são ordenados na grid in: query type: string – name: sort_order description: Indica se a ordenação deve ser em ordem ASC ou DESC in: query type: string – name: nome description: Nome utilizado como filtro in: query type: string responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: #/definitions/papelRec minimum: 1 description: Contém as linhas com os papéis pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError /web_interface/queries/listaTodosTenants: post: description: Retorna uma lista com todos os tenants, respeitando a paginação e a ordenação passadas como parâmetro 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 deve ser exibida na grid com todos os tenants count: type: integer format: int64 description: Indica qual a quantidade de tenants é mostrada em cada página nome: type: string description: Nome utilizado como filtro responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: #/definitions/tenantRec minimum: 1 description: Contém as linhas com os tenants pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os tenants, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Indica qual página deve ser exibida na grid com todos os tenants in: query type: integer format: int64 – name: count description: Indica qual a quantidade de tenants é mostrada em cada página in: query type: integer format: int64 – name: nome description: Nome utilizado como filtro in: query type: string responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: #/definitions/tenantRec minimum: 1 description: Contém as linhas com os tenants pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError /web_interface/queries/listaTodosUsuarios: post: description: Retorna uma lista com todos os usuarios, respeitando a paginação e a ordenação passadas como parâmetro 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 deve ser exibida na grid com todos os usuários count: type: integer format: int64 description: Indica qual a quantidade de usuários é mostrada em cada página sort_by: type: string description: Nome do campo pelo qual os usuários são ordenados na grid sort_order: type: string description: Indica se a ordenação deve ser em ordem ASC ou DESC nome: type: string description: Nome utilizado como filtro responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: #/definitions/usuarioRec minimum: 1 description: Contém as linhas com os usuários pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os usuarios, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Indica qual página deve ser exibida na grid com todos os usuários in: query type: integer format: int64 – name: count description: Indica qual a quantidade de usuários é mostrada em cada página in: query type: integer format: int64 – name: sort_by description: Nome do campo pelo qual os usuários são ordenados na grid in: query type: string – name: sort_order description: Indica se a ordenação deve ser em ordem ASC ou DESC in: query type: string – name: nome description: Nome utilizado como filtro in: query type: string responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: #/definitions/usuarioRec minimum: 1 description: Contém as linhas com os usuários pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError /web_interface/queries/listaUsuariosComFiltro: post: description: Retorna uma lista de usuários em ordem alfabética, de acordo com o filtro passado como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: nome: type: string description: Nome do usuário utilizado como filtro. Se nada for passado, retorna todos os usuários responses: 200: description: Ok schema: type: object properties: usuarios: type: array items: type: object allOf: #/definitions/usuarioRec description: Lista com os usuários filtrados default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de usuários em ordem alfabética, de acordo com o filtro passado como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: nome description: Nome do usuário utilizado como filtro. Se nada for passado, retorna todos os usuários in: query type: string responses: 200: description: Ok schema: type: object properties: usuarios: type: array items: type: object allOf: #/definitions/usuarioRec description: Lista com os usuários filtrados default: description: Error response schema: #/definitions/genericError /web_interface/queries/listPendenciesWithError: post: description: Retorna lista com as pendencias que falharam na integração 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 deve ser exibida na grid com todos os recursos count: type: integer format: int64 description: Indica qual a quantidade de pendencias é mostrada em cada página responses: 200: description: Ok schema: type: object required: – pendencies – pagination properties: pendencies: type: array items: type: object allOf: #/definitions/pendenciesWithError minimum: 1 description: pendencias com problema de sincronização pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid default: description: Error response schema: #/definitions/genericError get: description: Retorna lista com as pendencias que falharam na integração tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Indica qual página deve ser exibida na grid com todos os recursos in: query type: integer format: int64 – name: count description: Indica qual a quantidade de pendencias é mostrada em cada página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – pendencies – pagination properties: pendencies: type: array items: type: object allOf: #/definitions/pendenciesWithError minimum: 1 description: pendencias com problema de sincronização pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid default: description: Error response schema: #/definitions/genericError /web_interface/queries/obtemTenant: post: description: Busca um tenant através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idTenant properties: idTenant: type: string description: Identificador do tenant responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: type: object allOf: #/definitions/tenantCompletoRec description: Informações sobre o tenant default: description: Error response schema: #/definitions/genericError get: description: Busca um tenant através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idTenant description: Identificador do tenant in: query required: true type: string responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: type: object allOf: #/definitions/tenantCompletoRec description: Informações sobre o tenant default: description: Error response schema: #/definitions/genericError /web_interface/queries/obtemPropriedadesUsuario: post: description: Busca todas as propriedades de um usuário, através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario properties: idUsuario: type: string description: Identificador do usuário responses: 200: description: Ok schema: type: object required: – propriedades properties: propriedades: type: array items: type: object allOf: #/definitions/propriedadeRec minimum: 1 description: Lista com as propriedades que este usuário possui default: description: Error response schema: #/definitions/genericError get: description: Busca todas as propriedades de um usuário, através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idUsuario description: Identificador do usuário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – propriedades properties: propriedades: type: array items: type: object allOf: #/definitions/propriedadeRec minimum: 1 description: Lista com as propriedades que este usuário possui default: description: Error response schema: #/definitions/genericError /web_interface/queries/verificaConexaoLDAP: post: description: Verifica se os dados de conexão LDAP estão corretos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – servidorLDAP properties: servidorLDAP: type: object allOf: #/definitions/dadosConexaoLDAPrec description: Dados para conexão ao servidor LDAP responses: 200: description: Ok schema: type: object required: – conexaoOk properties: conexaoOk: type: boolean description: Booleano indicando se a conexão foi bem sucedida default: description: Error response schema: #/definitions/genericError /web_interface/queries/obtemGrupo: post: description: Busca um grupo através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idGrupo properties: idGrupo: type: string description: Identificador do grupo responses: 200: description: Ok schema: type: object required: – grupo properties: grupo: type: object allOf: #/definitions/grupoCompletoRec description: Informações sobre o grupo default: description: Error response schema: #/definitions/genericError get: description: Busca um grupo através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idGrupo description: Identificador do grupo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – grupo properties: grupo: type: object allOf: #/definitions/grupoCompletoRec description: Informações sobre o grupo default: description: Error response schema: #/definitions/genericError /web_interface/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 /web_interface/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 /web_interface/actions/atualizaGrupo: post: description: Atualiza um grupo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idGrupo – nomeGrupo – usuarios properties: idGrupo: type: string description: Identificador do grupo nomeGrupo: type: string description: Nome do grupo descricaoGrupo: type: string description: Descrição do grupo emailGrupo: type: string description: Email do grupo usuarios: type: array items: type: object allOf: #/definitions/usuarioGrupoRec minimum: 1 description: Lista com os usuários associados a este grupo responses: 200: description: Ok schema: type: object required: – idGrupo properties: idGrupo: type: string description: Identificador do grupo recém alterado default: description: Error response schema: #/definitions/genericError /web_interface/actions/insereGrupo: post: description: Insere um novo grupo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeGrupo – descricaoGrupo – emailGrupo – usuarios properties: nomeGrupo: type: string description: Nome do grupo descricaoGrupo: type: string description: Descrição do grupo (opcional) emailGrupo: type: string description: Email do grupo (opcional) usuarios: type: array items: type: object allOf: #/definitions/usuarioGrupoRec minimum: 1 description: Lista com os usuários associados a este grupo responses: 200: description: Ok schema: type: object required: – idGrupo properties: idGrupo: type: string description: Identificador do grupo recém adicionado default: description: Error response schema: #/definitions/genericError definitions: 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 headerRec: description: Header da grid de consulta de elementos type: object required: – key – name properties: key: type: string description: Identificador da coluna name: type: string description: Nome da coluna papelRec: description: Representa um papel type: object required: – idPapel – nomePapel – descricaoPapel properties: idPapel: type: string description: Identificador do papel nomePapel: type: string description: Nome do papel descricaoPapel: type: string description: Descrição do papel dominioSimplificadoRec: description: Representa um domínio simplificado, sem seus serviços type: object required: – nomeDominio – rotuloDominio – descricaoDominio properties: nomeDominio: type: string description: Nome do domínio rotuloDominio: type: string description: Rótulo do domínio descricaoDominio: type: string description: Descrição do domínio usuariosPaginationRec: description: Representa uma lista de usuários com suporte a paginação type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: #/definitions/usuarioRec minimum: 1 description: Contém as linhas com os usuários pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC propriedadeRec: description: Representa uma propriedade type: object required: – nomePropriedade – valorPropriedade properties: idPropriedade: type: string description: Identificador da propriedade nomePropriedade: type: string description: Nome da propriedade valorPropriedade: type: string description: Valor da propriedade tenantRec: description: Representa um tenant type: object required: – idTenant – nomeTenant properties: idTenant: type: string description: Identificador do tenant nomeTenant: type: string description: Nome do tenant pendenciesWithError: description: Representa uma pendencia de integração de usuário type: object required: – id – idItem – tableToReplicate – error – operation – createdAt – lastAttempt properties: id: type: string description: id da pendencia idItem: type: string description: idItem com falha na integração tableToReplicate: type: string description: nome da tabela da G5 para ser replicada error: type: string description: mensagem de erro do usuário com falha na integração operation: type: string description: nome da operação createdAt: type: string format: date-time description: data e hora de criação da pendencia lastAttempt: type: string format: date-time description: data e hora da última tentativa de sincronização paginationRec: description: Dados de paginação da grid das telas de consulta type: object required: – count – page – pages – size properties: count: type: integer format: int64 description: Quantidade de itens total page: type: integer format: int64 description: Página atual pages: type: integer format: int64 description: Quantidade de páginas total size: type: integer format: int64 description: Quantidade de itens por página tenantCompletoRec: description: Representa um tenant type: object required: – idTenant – dominioTenant – nome – primeiroNomeAdmin – sobrenomeAdmin – emailAdmin – senhaTamanhoMinimo – senhaTamanhoMaximo – senhaNumeros – senhaMinusculas – senhaMaiusculas – senhaEspeciais – key – secret – tipoAutenticacao – multiplosTokens – controleOrigemAcessoHabilitado – servidorEmail – servidorLDAP – master – tempoExpiracaoLembrarMe 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.. 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áxima de caracteres da senha senhaTamanhoMaximo: type: integer format: int64 description: Quantidade mínima 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 authenticationTypes: type: array items: type: string allOf: – #/definitions/authType description: Tipos de authenticação disponiíveis no tenant 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/dadosConexaoEmailRec description: Dados para conexão a um servidor SMTP servidorLDAP: type: object allOf: #/definitions/dadosLDAPrec description: Dados para conexão a um servidor LDAP master: type: boolean description: Indica se o tenant é master ativo: type: boolean description: Indica se o tenant está ativo localidade: type: string description: localidade do tenant urlTelaRedefinicaoSenha: type: string description: Url da tela de redefinição de senha. Se não for informado, irá utilizar a tela padrão da plataforma. 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 urlAposLogoff: type: string description: URL para redirecionamento após a realização do Logoff loginComLembrarMeHabilitado: type: boolean description: Permite que o usuário ative a opção de Lembrar Me no login. tempoExpiracaoLembrarMe: type: integer format: int64 description: Tempo de duração do cookie ao marcar a opção Lembrar Me na tela de login samlRedirectUrl: type: string description: URL de redirecionamento a ser utilizada pela requisição SAML idpEntityId: type: string description: Id da entidade do Identity Provider spEntityId: type: string description: Id da entidade do Service Provider samlLoginUrl: type: string description: URL do servidor SAML para realizar o login samlLogoffUrl: type: string description: URL do servidor SAML para realizar o logoff samlClaimUsername: type: string description: Claim que define o username do usuário samlClaimEmail: type: string description: Claim que define o email do usuário samlClaimName: type: string description: Claim que define o nome do usuário samlPapeis: type: array items: type: string description: Papel(eis) em que os novos usuários devem ser cadastrados ao utilizar autenticação SAML samlUseClaimUsername: type: boolean description: Define se a claim username será utilizada para definir o usuário subscriptionTier: type: string description: Nivel de inscrição do tenant (Valores válidos são listados pela primitiva usuarios.userManager.listAvailableTiers) replicationYieldThreshold: type: integer format: int64 description: O número de usuários limite a serem replicados antes da thread conceder lugar para outras executarem alterarSenhaAposLogin: 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. altDomains: type: array items: type: object allOf: #/definitions/recAltDomain description: recAltDomain: description: Dominio alternativo do tenant type: object required: – id – domain properties: id: type: string description: Identificador do dominio alternativo. DEPRECADO: Retornará sempre 00000000-0000-0000-0000-000000000000. domain: 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 dadosConexaoEmailRec: 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: integer format: int64 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 dadosConexaoLDAPrec: description: Representa os dados para conexão a um servidor LDAP discriminator: _discriminator type: object required: – host – port – SSLEnabled – user – password – searchBase – objectClass – userAttribute – usernameAttribute – descriptionAttribute – emailAttribute – userSearchFilter – userListFilter – _discriminator 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 defaultRoles: type: array items: type: string description: Nomes de papeis padrão para os usuários importados 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` _discriminator: type: string description: dadosLDAPrec: description: Representa os dados de configuração com o servidor LDAP allOf: – #/definitions/dadosConexaoLDAPrec – type: object usuarioRec: description: Representa um usuário simplificado, utilizado na grid de consulta type: object required: – idUsuario – nome – nomeCompleto – email – tipoAutenticacaoLabel properties: idUsuario: type: string description: Identificador do usuário nome: type: string description: Nome do usuário nomeCompleto: type: string description: Nome completo do usuário email: type: string description: Endereço de email do usuário tipoAutenticacaoLabel: type: string allOf: – #/definitions/authType description: Tipo de autenticação grupoCompletoRec: description: Representa um grupo e suas propriedades type: object required: – idGrupo – nomeGrupo – descricaoGrupo – emailGrupo – usuarios – filtros properties: idGrupo: type: string description: Identificador do grupo nomeGrupo: type: string description: Nome do grupo descricaoGrupo: type: string description: Descrição do grupo emailGrupo: type: string description: Email do grupo usuarios: type: object allOf: #/definitions/usuariosPaginationRec description: Lista com os usuários que este grupo possui filtros: type: array items: type: object allOf: #/definitions/dominioSimplificadoRec minimum: 1 description: Lista com os domínios dos filtros que este grupo possui. O conteúdo dos domínios é obtido sob demanda. usuarioGrupoRec: description: Representa um usuário, para a tela de grupos type: object required: – idUsuario – nomeUsuario properties: idUsuario: type: string description: Identificador do usuário nomeUsuario: type: string description: Nome do usuário 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