2.0info: 8.1.1 Gestão de Inquilinos description: Serviço para gestão de inquilinos. x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: tenant contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /platform/tenantsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /listTenantsPropertyValue: post: description: Lista os tenants e suas propriedades que atendem os valores informados nos parâmetros key e value x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – key – value properties: offset: type: integer description: Índice do primeiro registro. Se não for informado o valor será 0. limit: type: integer description: Quantidade de registros. Se não for informado o valor será 10. key: type: string description: Nome da propriedade value: type: string description: Valor da propriedade responses: 200: description: Ok schema: type: object required: – tenants – total properties: tenants: #/definitions/tenantProperties total: type: integer description: Retorna a quantidade de registros encontrados default: description: Error response schema: #/definitions/genericError get: description: Lista os tenants e suas propriedades que atendem os valores informados nos parâmetros key e value x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – key – value properties: offset: type: integer description: Índice do primeiro registro. Se não for informado o valor será 0. limit: type: integer description: Quantidade de registros. Se não for informado o valor será 10. key: type: string description: Nome da propriedade value: type: string description: Valor da propriedade responses: 200: description: Ok schema: type: object required: – tenants – total properties: tenants: #/definitions/tenantProperties total: type: integer description: Retorna a quantidade de registros encontrados default: description: Error response schema: #/definitions/genericError /configureTenantWSO2Settings: post: description: Realiza no WSO2 as configurações necessárias para as assinaturas, de acordo com o tier selecionado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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á utilizado um tier padrão. applicationName: type: string description: O nome da aplicação para as assinaturas das APIs. Se não definido, será configurado 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á tentando a geração automática dessas informações para o tenant. responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /configureTenantOriginAccessControlSettings: post: description: Altera as configurações de controle de acesso de um tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantDomain – enableOriginAccessControl properties: tenantDomain: type: string description: Domínio do tenant que deve ter as configurações de controle de acesso alteradas enableOriginAccessControl: type: boolean description: Indica se o controle de origem de acesso está habilitado trustedIpAddressesRanges: type: array items: #/definitions/ipAddressRange description: Faixas de endereços IP válidos para o controle de origem de acesso responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /configureTenantAuthenticationDefaultRolesSettings: post: description: Cria a associação de papéis padrões para o tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: arq.senior.com.br, tenant1.com.br defaultRoles: type: array items: type: string description: Papéis em que os novos usuários devem ser cadastrados ao utilizar autenticação responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /listTenants: post: description: Lista os inquilinos conforme os parâmetros. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: offset: type: integer description: Índice do primeiro inquilino. Se não for informado o valor será 0. limit: type: integer description: Quantidade de inquilinos. Se não for informado o valor será 10. filter: type: string description: Lista os inquilinos que contenham este texto no nome ou domínio. Se não for informado lista todos. active: type: boolean description: Permite filtrar por tenants ativos ou inativos. Se não informado lista todos. searchOperator: #/definitions/searchOperator responses: 200: description: Ok schema: type: object required: – tenants – total properties: tenants: #/definitions/tenant total: type: integer description: Quantidade total de inquilinos. default: description: Error response schema: #/definitions/genericError get: description: Lista os inquilinos conforme os parâmetros. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: offset: type: integer description: Índice do primeiro inquilino. Se não for informado o valor será 0. limit: type: integer description: Quantidade de inquilinos. Se não for informado o valor será 10. filter: type: string description: Lista os inquilinos que contenham este texto no nome ou domínio. Se não for informado lista todos. active: type: boolean description: Permite filtrar por tenants ativos ou inativos. Se não informado lista todos. searchOperator: #/definitions/searchOperator responses: 200: description: Ok schema: type: object required: – tenants – total properties: tenants: #/definitions/tenant total: type: integer description: Quantidade total de inquilinos. default: description: Error response schema: #/definitions/genericError /configureTenantPasswordPolicySettings: post: description: Configura a política de senha do tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantDomain – passwordPolicySettings properties: tenantDomain: type: string description: tenant para configurar politica de senha passwordPolicySettings: #/definitions/passwordPolicySettings responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /configureTenantReplicationSettings: post: description: Realiza as configurações de replicação para o tenant selecionado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: O domínio do tenant replicationYieldThreshold: type: integer description: Número de usuários limite a serem replicados antes da thread conceder lugar para outras executarem responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /testOnPremiseConnection: post: description: Testa a conexão com a plataforma on-premises x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – tests properties: tests: #/definitions/testOnPremiseConnectionResponse default: description: Error response schema: #/definitions/genericError get: description: Testa a conexão com a plataforma on-premises x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – tests properties: tests: #/definitions/testOnPremiseConnectionResponse default: description: Error response schema: #/definitions/genericError /configureTenantEmailSettings: post: description: Altera as configurações de e-mail de um tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 smtpHost: type: string description: Nome do servidor de email smtpPort: type: integer description: Porta IP do servidor de email smtpUser: type: string description: Usuário do servidor SMTP smtpPassword: type: string description: Senha do usuário requiresAuthentication: type: boolean description: Indica se a autenticação é necessária ou não sslEnabled: type: boolean description: SSL Trust habilitado tlsEnabled: type: boolean description: TLS habilitado responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /removeTenant: post: description: Remove um tenant da base e do API Manager x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: O domínio do tenant a ser removido utilizando o formato namespace: hcm.senior.com.br, tenant1.com.br responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /listTenantsProperties: post: description: Lista os tenants e suas propriedades se este contém um das propriedades informadas no atributo keys x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – keys properties: offset: type: integer description: Índice do primeiro registro. Se não for informado o valor será 0. limit: type: integer description: Quantidade de registros. Se não for informado o valor será 10. keys: type: array items: type: string description: Nome das propriedades responses: 200: description: Ok schema: type: object required: – tenants – total properties: tenants: #/definitions/tenantProperties total: type: integer description: Retorna a quantidade de registros encontrados default: description: Error response schema: #/definitions/genericError get: description: Lista os tenants e suas propriedades se este contém um das propriedades informadas no atributo keys x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – keys properties: offset: type: integer description: Índice do primeiro registro. Se não for informado o valor será 0. limit: type: integer description: Quantidade de registros. Se não for informado o valor será 10. keys: type: array items: type: string description: Nome das propriedades responses: 200: description: Ok schema: type: object required: – tenants – total properties: tenants: #/definitions/tenantProperties total: type: integer description: Retorna a quantidade de registros encontrados default: description: Error response schema: #/definitions/genericError /saveProperties: post: description: Salva as propriedades no tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Nome do tenant toCreate: type: array items: #/definitions/property description: Lista de propriedades que devem ser criadas ou atualizadas toDelete: type: array items: #/definitions/property description: Lista de propriedades que devem ser excluidas responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok default: description: Error response schema: #/definitions/genericError /configureTenantLDAPSettings: post: description: Cria uma nova conexão LDAP x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantDomain – ldapSettings properties: tenantDomain: type: string description: tenant onde será configurado a conexão LDAP ldapSettings: #/definitions/LDAPSettings responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /configureTenantAuthenticationSettings: post: description: Altera as configurações de autenticação de um tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 authenticationTypes: type: array items: #/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 rememberMeEnabled: type: boolean description: Permite que o usuário ative a opção de Lembrar Me no login rememberMeDuration: type: integer description: Tempo de duração do cookie (em horas) ao marcar a opção Lembrar Me na tela de login 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. 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. responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /getTenantWithConfigurations: post: description: Obtém todos os dados de um tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: tenant: type: string description: O nome ou domínio do tenant a ter os dados retornados. Se não informado, retornará os dados do tenant em contexto responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: #/definitions/tenantWithConfigurations default: description: Error response schema: #/definitions/genericError get: description: Obtém todos os dados de um tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: tenant: type: string description: O nome ou domínio do tenant a ter os dados retornados. Se não informado, retornará os dados do tenant em contexto responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: #/definitions/tenantWithConfigurations default: description: Error response schema: #/definitions/genericError /listPublicKeyFiles: post: description: Lista os arquivos conforme os parâmetros. x-senior-event: false deprecated: true tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: offset: type: integer description: Índice do primeiro arquivo. Se não for informado o valor será 0. limit: type: integer description: Quantidade de arquivos. Se não for informado o valor será 10. responses: 200: description: Ok schema: type: object required: – files – total properties: files: #/definitions/publicKeyFile total: type: integer description: Quantidade total de arquivos. default: description: Error response schema: #/definitions/genericError get: description: Lista os arquivos conforme os parâmetros. x-senior-event: false deprecated: true tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: offset: type: integer description: Índice do primeiro arquivo. Se não for informado o valor será 0. limit: type: integer description: Quantidade de arquivos. Se não for informado o valor será 10. responses: 200: description: Ok schema: type: object required: – files – total properties: files: #/definitions/publicKeyFile total: type: integer description: Quantidade total de arquivos. default: description: Error response schema: #/definitions/genericError /getUrlAfterLogoff: post: description: Obtém a configuração do tenant da URL para onde o usuário deve ser redirecionado após o logoff x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – urlAfterLogoff properties: urlAfterLogoff: 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 x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – urlAfterLogoff properties: urlAfterLogoff: type: string description: URL para redirecionamento após a realização do logoff default: description: Error response schema: #/definitions/genericError /listAvailableTiers: post: description: Lista os Tiers disponíveis no WSO2 x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – tiers properties: tiers: #/definitions/tier default: description: Error response schema: #/definitions/genericError get: description: Lista os Tiers disponíveis no WSO2 x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – tiers properties: tiers: #/definitions/tier default: description: Error response schema: #/definitions/genericError /getAuthenticationTypes: post: description: Obtém os tipos de autenticação utilizados no tenant do contexto x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object properties: authenticationTypes: #/definitions/authenticationTypes default: description: Error response schema: #/definitions/genericError get: description: Obtém os tipos de autenticação utilizados no tenant do contexto x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object properties: authenticationTypes: #/definitions/authenticationTypes default: description: Error response schema: #/definitions/genericError /getTenantByName: post: description: Obtêm os dados de um tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: O nome do tenant a ter os dados retornados responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: #/definitions/tenant default: description: Error response schema: #/definitions/genericError get: description: Obtêm os dados de um tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: O nome do tenant a ter os dados retornados responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: #/definitions/tenant default: description: Error response schema: #/definitions/genericError /listProperties: post: description: Lista as propriedades do tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Nome do tenant responses: 200: description: Ok schema: type: object required: – properties properties: properties: #/definitions/property default: description: Error response schema: #/definitions/genericError get: description: Lista as propriedades do tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Nome do tenant responses: 200: description: Ok schema: type: object required: – properties properties: properties: #/definitions/property default: description: Error response schema: #/definitions/genericError /isTenantMaster: post: description: Indica se o usuário é do tenant master x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – isMaster properties: isMaster: type: boolean description: Indica se o usuário é do tenant master default: description: Error response schema: #/definitions/genericError get: description: Indica se o usuário é do tenant master x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – isMaster properties: isMaster: type: boolean description: Indica se o usuário é do tenant master default: description: Error response schema: #/definitions/genericError /createTenant: post: description: Cria um tenant com o mínimo de informação necessária x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantName – tenantDomain – adminEmail – adminPassword properties: tenantName: type: string description: O nome do tenant, suportando apenas caracteres e números tenantDomain: type: string description: O domínio do tenant, utilizando o formato de namespace: hcm.senior.com.br, tenant1.com.br adminFirstName: type: string description: Nome do administrador. Se não definido, será considerado Administrador adminLastName: type: string description: Sobrenome do administrador. Se não definido, será considerado Sistema adminEmail: type: string description: O e-mail do usuário administrador adminPassword: type: string description: A senha do usuário administrador, com no mínimo 5 caracteres notificationEmail: #/definitions/notificationEmail altDomains: type: array items: type: string description: Domínios alternativos anyDocument: type: string description: Documento de identificação Pessoa Física/Pessoa Jurídica através de qualquer documento, exemplo: (CPF/CNPJ) e/ou estrangeiras (SSN/NIT/TIN/RFC/Passaporte) etc integrationCode: type: string description: Código de indetificação do cliente. O código é do tipo string devido a possibilidade de integrar com outros sistemas responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /configureTenantGeneralSettings: post: description: Configura os dados gerais do tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: arq.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 adminEmail: type: string description: O e-mail do administrador do tenant. adminFirstName: type: string description: Nome do administrador do tenant. Se não definido, será considerado Administrador. adminLastName: type: string description: Sobrenome do administrador do tenant. Se não definido, será considerado Sistema. contacts: type: array items: #/definitions/contact description: Contatos dos responsáveis pelo 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 default: description: Error response schema: #/definitions/genericError /deactivateTenant: post: description: Desativa o tenant passado como parâmetro x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantName – deactivationReason properties: tenantName: type: string description: Nome do tenant deactivationReason: type: string description: Motivo da desativação responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /getPublicKeyFile: post: description: Lista os arquivos conforme os parâmetros. x-senior-event: false deprecated: true tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome do arquivos de chaves desejado responses: 200: description: Ok schema: type: object required: – name – fileName – fileContent properties: name: type: string description: Nome que identifica o arquivo, único e imutável. fileName: type: string description: Nome original do arquivo importado. fileContent: type: string description: Conteúdo do arquivo importado. default: description: Error response schema: #/definitions/genericError get: description: Lista os arquivos conforme os parâmetros. x-senior-event: false deprecated: true tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome do arquivos de chaves desejado responses: 200: description: Ok schema: type: object required: – name – fileName – fileContent properties: name: type: string description: Nome que identifica o arquivo, único e imutável. fileName: type: string description: Nome original do arquivo importado. fileContent: type: string description: Conteúdo do arquivo importado. default: description: Error response schema: #/definitions/genericError /addPublicKeyFile: post: description: Inclui uma nova cadeia de chaves públicas para o inquilino, identificada pelo seu nome. Não é permitido sua atualização. x-senior-event: false deprecated: true tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/publicKeyFile responses: 200: description: Ok schema: type: object required: – name properties: name: type: string description: Nome gerado conforme requisição. default: description: Error response schema: #/definitions/genericError /getTenantByDomain: post: description: Obtêm os dados de um tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: O domínio do tenant a ter os dados retornados responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: #/definitions/tenant default: description: Error response schema: #/definitions/genericError get: description: Obtêm os dados de um tenant x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: O domínio do tenant a ter os dados retornados responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: #/definitions/tenant default: description: Error response schema: #/definitions/genericError /configureTenantSAMLSettings: post: description: Cria uma nova conexão SAML x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantDomain – samlSettings properties: tenantDomain: type: string description: O domínio do tenant utilizando o formato de namespace: arq.senior.com.br, hcm.senior.com.br samlSettings: #/definitions/SAMLSettings responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /activateTenant: post: description: Ativa o tenant passado como parâmetro x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /removeShovels: post: description: Remove as configurações de shovel. x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: string description: Inquilinos para os quais o shovel deve ser removido responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /configureShovels: post: description: Configura o ambiente para os serviços on premises. x-senior-event: false deprecated: false tags: – Signals security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: string description: Inquilinos para os quais o ambiente deve ser configurado. responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /shovelConfigurationChanged: post: description: Alteração nas configurações de shovel de um tenant x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: O tenant que teve as configurações de shovel alteradas. active: type: boolean description: Indica se a configuração do shovel está ativa. services: type: array items: #/definitions/serviceId description: Lista de serviços instalados on premises responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tenantReady: post: description: Evento que indica que o tenant e todas as dependências estão prontas x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: O nome tenant que está pronto responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tenantChanged: post: description: Evento indicando que houveram alterações no tenant x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantName – tenantDomain – active properties: tenantName: type: string description: Nome do tenant tenantDomain: type: string description: Domínio do tenant active: type: boolean description: Situação do tenant se ativo ou inativo master: type: boolean description: Indica se o tenant é master. Quando não informado, indica que o tenant não é master. responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tenantReactivated: post: description: Evento indica que um tenant que estava desativado foi ativado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tenantDeactivated: post: description: Evento indica que um tenant que estava ativo foi desativado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tenantIncluded: post: description: Evento indicando que um tenant foi criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantName – tenantDomain properties: tenantName: type: string description: Nome do tenant tenantDomain: type: string description: Domínio do tenant responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tenantRemoved: post: description: Evento indicando que um tenant foi removido x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantName – tenantDomain properties: tenantName: type: string description: Nome do tenant tenantDomain: type: string description: Domínio do tenant responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tenantLocaleChanged: post: description: Evento indicando quando a localidade do tenant é alterada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantName – locale properties: tenantName: type: string description: Nome do tenant locale: type: string description: Nova localidade responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /tenantAltDomainsChanged: post: description: Evento indicando quando há alteração nos domínios alternativos do tenant x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant altDomains: type: array items: type: string description: Novos domínios alternativos do tenant responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /maintenanceStarted: post: description: Uma janela de manutenção foi iniciada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: string description: Nome dos tenants que tiveram sua janela de manutenção iniciada responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /maintenanceFinished: post: description: Uma janela de manutenção foi terminada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: string description: Nome dos tenants que tiveram sua janela de manutenção terminada responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: authType: type: string enum: – G7 – G5 – LDAP – SAML searchOperator: type: string enum: – EQUAL – CONTAINS – STARTS_WITH – ENDS_WITH testOnPremiseConnectionStage: type: string enum: – CONFIGURATION – HOST – HTTP – LOGIN – AMQP serviceId: type: object required: – domain – service properties: domain: type: string description: Nome do domínio service: type: string description: Nome do serviço tenant: type: object required: – name – domain – active – master – locale – email properties: name: type: string description: Nome do tenant. domain: type: string description: O domínio do tenant active: type: boolean description: Indica se o tenant está ativo. master: type: boolean description: Indica se o tenant é master. locale: type: string description: O locale do tenant ready: type: boolean description: Se o processamento de ativação foi realizado altDomains: type: array items: type: string description: Lista de domínios alternativos do tenant email: type: string description: E-mail do admin do tenant authTypes: type: array items: #/definitions/authType description: Tipos de autenticação suportados pelo tenant anyDocument: type: string description: Documento de identificação Pessoa Física/Pessoa Jurídica através de qualquer documento, exemplo: (CPF/CNPJ) e/ou estrangeiras (SSN/NIT/TIN/RFC/Passaporte) etc integrationCode: type: string description: Código de indetificação do cliente. O código é do tipo string devido a possibilidade de integrar com outros sistemas deactivationReason: type: string description: Motivo da desativação do tenant deactivationUser: type: string description: O usuário que desativou o tenant deactivationMoment: type: string description: Data e hora em que o tenant foi desativado format: date-time underMaintenance: type: boolean description: Indica que o inquilino está presente em uma janela de manutenção tenantWithConfigurations: type: object required: – name – domain – active – master – locale – adminFirstName – adminLastName – adminEmail – contacts – wso2Key – wso2Secret – multipleTokensEnabled – passwordPolicySettings – originAccessControlEnabled properties: name: type: string description: Nome do tenant domain: type: string description: O domínio do tenant active: type: boolean description: Indica se o tenant está ativo. master: type: boolean description: Indica se o tenant é master. locale: type: string description: O locale do tenant ready: type: boolean description: Se todo o processamento de ativação foi realizado altDomains: type: array items: type: string description: Lista de domínios alternativos do tenant adminFirstName: type: string description: Primeiro nome do administrador adminLastName: type: string description: Sobrenome do administrador adminEmail: type: string description: E-mail do administrador contacts: type: array items: #/definitions/contact description: E-mail dos administradores que responsáveis pelo tenant urlAfterLogoff: type: string description: URL para redirecionamento após a realização do Logoff emailSettings: #/definitions/emailSettings wso2Key: type: string description: Chave de acesso ao portal, obtido no API Manager wso2Secret: type: string description: Segredo para acesso ao portal, obtido no API Manager subscriptionTier: type: string description: Nivel de inscrição do tenant (Valores válidos são listados pela primitiva platform.tenant.listAvailableTiers) applicationName: type: string description: O nome da aplicação desse tenant no API Manager replicationYieldThreshold: type: integer description: O número de usuários limite a serem replicados antes da thread conceder lugar para outras executarem authenticationTypes: type: array items: #/definitions/authType description: Tipos de autenticação disponíveis no tenant multipleTokensEnabled: type: boolean description: Indica se para cada sessão do usuário deve ser gerado um novo token rememberMeDuration: type: integer description: Tempo de duração do cookie ao marcar a opção Lembrar Me na tela de login rememberMeEnabled: type: boolean description: Permite que o usuário ative a opção de Lembrar Me no login. changePasswordAfterLogin: 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. canChangePasswordG5: 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. passwordPolicySettings: #/definitions/passwordPolicySettings originAccessControlEnabled: type: boolean description: Indica se o controle de origem de acesso está habilitado validIPsRange: type: array items: #/definitions/ipAddressRange description: As faixas de IPs válidos para o controle de origem de acesso ldapSettings: #/definitions/LDAPSettings samlSettings: #/definitions/SAMLSettings defaultRoles: type: array items: type: string description: Nome dos papéis padrões adminPassword: type: string description: Senha do admin do wso2 do tenant. Só será informada se a mensagem for trusted e for feita através de um dos seguintes serviços: user, usuarios, application-management, authentication ou externalusers. deactivationMoment: type: string description: Data e hora em que o tenant foi desativado. format: date-time deactivationReason: type: string description: Motivo da desativação informado pelo usuário. deactivationUser: type: string description: Usuário que desativou o tenant. underMaintenance: type: boolean description: Indica que o inquilino está presente em uma janela de manutenção contact: type: object required: – firstName – lastName – email properties: firstName: type: string description: Primeiro nome do contato lastName: type: string description: Sobrenome do contato email: type: string description: E-mail do contato emailSettings: type: object properties: host: type: string description: Nome do servidor de email port: type: integer 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 passwordPolicySettings: type: object required: – minimumPasswordLength – maximumPasswordLength properties: minimumPasswordLength: type: integer description: Quantidade mínima de caracteres da senha maximumPasswordLength: type: integer description: Quantidade máxima de caracteres da senha requireNumbers: type: boolean description: (NOTA: Atributo deprecado. A configuração mínima da política de senha requer o valor true.) Indica se devem existir caracteres numéricos na senha requireLowercase: type: boolean description: (NOTA: Atributo deprecado. A configuração mínima da política de senha requer o valor true.) Indica se devem existir caracteres minúsculos na senha requireUppercase: type: boolean description: (NOTA: Atributo deprecado. A configuração mínima da política de senha requer o valor true.) Indica se devem existir caracteres maiúsculos na senha requireSpecialCharacters: type: boolean description: (NOTA: Atributo deprecado. A configuração mínima da política de senha requer o valor true.) 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. customRecaptchaKeys: #/definitions/customRecaptchaKeys customRecaptchaKeys: type: object properties: siteKey: type: string description: Chave pública (siteKey) do Recaptcha. Quando não informado/vazio, apaga as chaves customizadas. secretKey: type: string description: Chave secreta (secretKey) do Recaptcha. Na resposta da primitiva getTenantWithConfigurations, só será informada se a mensagem for trusted. Quando não informado/vazio, não modifica a secretKey já gravada. ipAddressRange: type: object required: – startIpAddress properties: startIpAddress: type: string description: Endereço inicial da faixa de IPs endIpAddress: type: string description: Endereço final da faixa de IPs LDAPSettings: type: object required: – host – port – sslEnabled – user – password – searchBase – userAttribute – usernameAttribute – descriptionAttribute – emailAttribute – userListFilter properties: host: type: string description: Nome do servidor LDAP port: type: integer 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: Esse campo não era necessário ou sequer utilizado, será removido em 07/2022. 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: Esse campo não era necessário ou sequer utilizado, será removido em 07/2022. userListFilter: type: string description: Critério de pesquisa de usuários 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` SAMLSettings: 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 userNameClaim: type: string description: Claim que define o username do usuário emailClaim: type: string description: Claim que define o email do usuário nameClaim: type: string description: Claim que define o nome do usuário useUserNameClaim: type: boolean description: Define se a claim username será utilizada para definir o usuário authenticationRequestSigning: type: boolean description: Ativa a assinatura da requisição de autenticação assertionSigning: type: boolean description: Ativa a assinatura dos assertions do SAML2 identityProviderPublicCertificate: type: string description: Certificado público do provedor de identidade no formato PEM. Obrigatório informar caso o campo assertionSigning for true tenantProperties: type: object required: – name – domain properties: name: type: string description: Nome do tenant. domain: type: string description: O domínio do tenant properties: type: array items: #/definitions/property description: Propriedades do tenant property: type: object required: – key – value properties: key: type: string description: Nome da propriedade value: type: string description: Valor da propriedade publicKeyFile: type: object required: – name – fileName – fileContent properties: name: type: string description: Nome que identifica o arquivo, único e imutável. fileName: type: string description: Nome original do arquivo importado. fileContent: type: string description: Conteúdo do arquivo importado. authenticationTypes: type: object required: – type – allowsChangePassword – allowsChangePasswordAfterAuthentication properties: type: #/definitions/authType 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. tier: type: object required: – name – description properties: name: type: string description: Nome do tier description: type: string description: Descrição do tier notificationEmail: 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 testOnPremiseConnectionResponse: type: object required: – stage – success properties: stage: #/definitions/testOnPremiseConnectionStage success: type: boolean description: Indica se o teste resultou com sucesso error: type: string description: Mensagem de erro caso o teste tenha falhado solution: type: string description: Dica ou solução para o erro informado 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