2.0info: 8.9.0 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: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /tenant/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/listTenants: post: description: Lista os inquilinos conforme os parâmetros. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Índice do primeiro inquilino. Se não for informado o valor será 0. limit: type: integer format: int64 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: type: string allOf: – #/definitions/searchOperator description: Operador para diminuir ou aumentar a abragência da pesquisa dos tenants, valor default CONTAINS responses: 200: description: Ok schema: type: object required: – tenants – total properties: tenants: type: array items: type: object allOf: – #/definitions/tenant minimum: 1 description: Inquilinos listados. total: type: integer format: int64 description: Quantidade total de inquilinos. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/listMasterTenants: post: description: Lista os inquilinos master. Somente pode ser chamado com o atributo trusted. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – tenants properties: tenants: type: array items: type: object allOf: – #/definitions/tenant minimum: 1 description: Inquilinos master. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os inquilinos master. Somente pode ser chamado com o atributo trusted. tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – tenants properties: tenants: type: array items: type: object allOf: – #/definitions/tenant minimum: 1 description: Inquilinos master. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getShovelledServiceInfo: post: description: Informações do shovel que estão aplicadas ao ambiente para um serviço. Necessário que a feature newConfigureShovelAPI esteja habilitada. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – serviceId properties: serviceId: type: object allOf: – #/definitions/serviceId description: Domínio/serviço. responses: 200: description: Ok schema: type: object required: – shovelledServiceInfo properties: shovelledServiceInfo: type: object allOf: – #/definitions/shovelledService description: Informações do shovel que estão aplicadas ao ambiente para o serviço. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getOnPremisesTenants: post: description: Lista os tenants que tem o serviço configurado on premises. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – serviceId properties: serviceId: type: object allOf: – #/definitions/serviceId description: Domínio/serviço. responses: 200: description: Ok schema: type: object properties: tenants: type: array items: type: string description: Tenants que tem o serviço on premises. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/listTenantsBasicInfo: post: description: Traz o nome, o domínio e os subdomínios dos tenants que estão ativos. Se a chamada não for feita pelo tenant master, trará somente as informações do tenant corrente. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: authType: type: string allOf: – #/definitions/authType description: Filtro de tipo de autenticação que o tenant possui. pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Se não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – listInformation properties: tenants: type: array items: type: object allOf: – #/definitions/tenantBasicInfo description: Informações dos tenants listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre os resultados da listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getTenantByName: post: description: Obtêm os dados de um tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – 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: type: object allOf: – #/definitions/tenant description: Dados do tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtêm os dados de um tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: tenantName description: O nome do tenant a ter os dados retornados in: query required: true type: string responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: type: object allOf: – #/definitions/tenant description: Dados do tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getTenantByDomain: post: description: Obtêm os dados de um 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 a ter os dados retornados responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: type: object allOf: – #/definitions/tenant description: Dados do tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtêm os dados de um tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: tenantDomain description: O domínio do tenant a ter os dados retornados in: query required: true type: string responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: type: object allOf: – #/definitions/tenant description: Dados do tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getTenantsByDocumentOrIntegrationCode: post: description: Obtêm os dados dos tenants através do documento ou código de integração tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: anyDocument: type: string description: Documento de identificação Pessoa Física/Jurídica através de qualquer documento, exemplo: (CPF/CNPJ) e/ou estrangeiras (SSN/NIT/TIN/RFC/Passaporte) integrationCode: type: string description: Código de identificação do cliente. O código é do tipo string devido a possibilidade de integrar com outros sistemas responses: 200: description: Ok schema: type: object required: – tenants properties: tenants: type: array items: type: object allOf: – #/definitions/tenant minimum: 1 description: Dados dos tenants 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtêm os dados dos tenants através do documento ou código de integração tags: – Queries x-senior-visibility: PUBLIC parameters: – name: anyDocument description: Documento de identificação Pessoa Física/Jurídica através de qualquer documento, exemplo: (CPF/CNPJ) e/ou estrangeiras (SSN/NIT/TIN/RFC/Passaporte) in: query type: string – name: integrationCode description: Código de identificação do cliente. O código é do tipo string devido a possibilidade de integrar com outros sistemas in: query type: string responses: 200: description: Ok schema: type: object required: – tenants properties: tenants: type: array items: type: object allOf: – #/definitions/tenant minimum: 1 description: Dados dos tenants 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getTenantWithConfigurations: post: description: Obtém todos os dados de um tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – 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: type: object allOf: – #/definitions/tenantWithConfigurations description: Informações completas do tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém todos os dados de um tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: tenant description: O nome ou domínio do tenant a ter os dados retornados. Se não informado, retornará os dados do tenant em contexto in: query type: string responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: type: object allOf: – #/definitions/tenantWithConfigurations description: Informações completas do tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getUrlAfterLogoff: 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: – urlAfterLogoff properties: urlAfterLogoff: type: string description: URL para redirecionamento após a realização do logoff 401: description: Invalid Credentials 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: – urlAfterLogoff properties: urlAfterLogoff: type: string description: URL para redirecionamento após a realização do logoff 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/listPublicKeyFiles: post: description: API DEPRECIADA: null | DATA: 2022-06-30 | Lista os arquivos conforme os parâmetros. tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Índice do primeiro arquivo. Se não for informado o valor será 0. limit: type: integer format: int64 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: type: array items: type: object allOf: – #/definitions/publicKeyFile minimum: 1 description: Arquivos listados. total: type: integer format: int64 description: Quantidade total de arquivos. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: null | DATA: 2022-06-30 | Lista os arquivos conforme os parâmetros. tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: offset description: Índice do primeiro arquivo. Se não for informado o valor será 0. in: query type: integer format: int64 – name: limit description: Quantidade de arquivos. Se não for informado o valor será 10. in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – files – total properties: files: type: array items: type: object allOf: – #/definitions/publicKeyFile minimum: 1 description: Arquivos listados. total: type: integer format: int64 description: Quantidade total de arquivos. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/isTenantMaster: post: description: Indica se o usuário é do tenant master tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – isMaster properties: isMaster: type: boolean description: Indica se o usuário é do tenant master 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Indica se o usuário é do tenant master tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – isMaster properties: isMaster: type: boolean description: Indica se o usuário é do tenant master 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getPublicKeyFile: post: description: API DEPRECIADA: null | DATA: 2022-06-30 | Lista os arquivos conforme os parâmetros. tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – 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 allOf: – #/definitions/publicKeyFile 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: null | DATA: 2022-06-30 | Lista os arquivos conforme os parâmetros. tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: name description: Nome do arquivos de chaves desejado in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/publicKeyFile 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/listTenantsProperties: post: description: Lista os tenants e suas propriedades se este contém um das propriedades informadas no atributo keys tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – keys properties: offset: type: integer format: int64 description: Índice do primeiro registro. Se não for informado o valor será 0. limit: type: integer format: int64 description: Quantidade de registros. Se não for informado o valor será 10. keys: type: array items: type: string minimum: 1 description: Nome das propriedades responses: 200: description: Ok schema: type: object required: – tenants – total properties: tenants: type: array items: type: object allOf: – #/definitions/tenantProperties minimum: 1 description: Retorna uma lista de tenants total: type: integer format: int64 description: Retorna a quantidade de registros encontrados 401: description: Invalid Credentials 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 tags: – Queries x-senior-visibility: PUBLIC parameters: – name: offset description: Índice do primeiro registro. Se não for informado o valor será 0. in: query type: integer format: int64 – name: limit description: Quantidade de registros. Se não for informado o valor será 10. in: query type: integer format: int64 – name: keys description: Nome das propriedades in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – tenants – total properties: tenants: type: array items: type: object allOf: – #/definitions/tenantProperties minimum: 1 description: Retorna uma lista de tenants total: type: integer format: int64 description: Retorna a quantidade de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/listTenantsPropertyValue: post: description: Lista os tenants e suas propriedades que atendem os valores informados nos parâmetros key e value tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – key – value properties: offset: type: integer format: int64 description: Índice do primeiro registro. Se não for informado o valor será 0. limit: type: integer format: int64 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: type: array items: type: object allOf: – #/definitions/tenantProperties minimum: 1 description: Retorna uma lista de tenants total: type: integer format: int64 description: Retorna a quantidade de registros encontrados 401: description: Invalid Credentials 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 tags: – Queries x-senior-visibility: PUBLIC parameters: – name: offset description: Índice do primeiro registro. Se não for informado o valor será 0. in: query type: integer format: int64 – name: limit description: Quantidade de registros. Se não for informado o valor será 10. in: query type: integer format: int64 – name: key description: Nome da propriedade in: query required: true type: string – name: value description: Valor da propriedade in: query required: true type: string responses: 200: description: Ok schema: type: object required: – tenants – total properties: tenants: type: array items: type: object allOf: – #/definitions/tenantProperties minimum: 1 description: Retorna uma lista de tenants total: type: integer format: int64 description: Retorna a quantidade de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/listProperties: post: description: Lista as propriedades do tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – 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: type: array items: type: object allOf: – #/definitions/property minimum: 1 description: Retorna as propriedades do tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as propriedades do tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: tenant description: Nome do tenant in: query required: true type: string responses: 200: description: Ok schema: type: object required: – properties properties: properties: type: array items: type: object allOf: – #/definitions/property minimum: 1 description: Retorna as propriedades do tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getAuthenticationTypes: post: description: Obtém os tipos de autenticação utilizados no tenant do contexto tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object properties: authenticationTypes: type: array items: type: object allOf: – #/definitions/authenticationTypes description: Lista com os tipos de autenticação do tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os tipos de autenticação utilizados no tenant do contexto tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object properties: authenticationTypes: type: array items: type: object allOf: – #/definitions/authenticationTypes description: Lista com os tipos de autenticação do tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/testOnPremiseConnection: post: description: Testa a conexão com a plataforma on-premises tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – tests properties: tests: type: array items: type: object allOf: – #/definitions/testOnPremiseConnectionResponse minimum: 1 description: Informações sobre os resultados dos testes on-premises 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Testa a conexão com a plataforma on-premises tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – tests properties: tests: type: array items: type: object allOf: – #/definitions/testOnPremiseConnectionResponse minimum: 1 description: Informações sobre os resultados dos testes on-premises 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/blacklistEmails: post: description: Lista de e-mails sem autorização para criar novos tenants tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – emails properties: emails: type: array items: type: string minimum: 1 description: E-mails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista de e-mails sem autorização para criar novos tenants tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – emails properties: emails: type: array items: type: string minimum: 1 description: E-mails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/createDefaultTenant: post: description: Cria o tenant padrão. NOTA: Esse endpoint é utilizado unicamente na configuração de um novo ambiente. tags: – Actions x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /tenant/actions/startMaintenance: post: description: API de uso interno pela plataforma para inicializar janelas de manutenção. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenants – revokeTokens properties: tenants: type: array items: type: string minimum: 1 description: Lista de tenants que deverão ter sua janela de manutenção iniciada.\nSe algum tenant não for encontrado ou o mesmo estiver desativado, um erro será retornado reason: type: string description: Personalizar o motivo da janela revokeTokens: type: boolean description: Se os tokens do tenant deverão ser revogados. estimateDate: type: string format: date-time description: Data de expectativa de fim, se informado, será informativo apenas. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/finishMaintenance: post: description: API de uso interno pela plataforma para finalizar janelas de manutenção. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: string minimum: 1 description: Lista de tenants que terão sua janela de manutenção finalizada, se estiverem em uma. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/addPublicKeyFile: post: description: API DEPRECIADA: null | DATA: 2022-06-30 | Inclui uma nova cadeia de chaves públicas para o inquilino, identificada pelo seu nome. Não é permitido sua atualização. tags: – Actions deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/publicKeyFile responses: 200: description: Ok schema: type: object required: – name properties: name: type: string description: Nome gerado conforme requisição. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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: – tenantName – tenantDomain – adminEmail – adminPassword properties: tenantName: type: string maxLength: 32 description: O nome do tenant, suportando apenas caracteres e números tenantDomain: type: string maxLength: 32 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: 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 anyDocument: type: string maxLength: 50 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 maxLength: 100 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 schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/removeTenant: post: description: Remove um tenant da base e do API Manager tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain properties: tenantDomain: type: string description: O domínio do tenant a ser removido utilizando o formato namespace: hcm.senior.com.br, tenant1.com.br responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/activateTenant: 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: – tenantName properties: tenantName: type: string description: Nome do tenant responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/deactivateTenant: 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: – tenantName – deactivationReason properties: tenantName: type: string description: Nome do tenant deactivationReason: type: string description: Motivo da desativação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/saveProperties: post: description: Salva as propriedades no tenant tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Nome do tenant toCreate: type: array items: type: object allOf: – #/definitions/property description: Lista de propriedades que devem ser criadas ou atualizadas toDelete: type: array items: type: object allOf: – #/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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: 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: type: object allOf: – #/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 schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/configureTenantEmailSettings: post: description: Altera as configurações de e-mail 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 smtpHost: type: string description: Nome do servidor de email smtpPort: type: integer format: int64 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 schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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á 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 schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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: Número de usuários limite a serem replicados antes da thread conceder lugar para outras executarem minimum: 1 responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/configureTenantAliasSettings: post: description: Define aliases para o tenant selecionado. O novo alias não pode conflitar com outros tenants, domínios e seus respectivos aliases. 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 tenantAlias: type: string maxLength: 255 description: Alias para o nome do tenant domainAlias: type: string maxLength: 255 description: Alias para o domínio do tenant responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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 – ldapSettings properties: tenantDomain: type: string description: tenant onde será configurado a conexão LDAP ldapSettings: type: object allOf: – #/definitions/LDAPSettings description: Dados das configurações LDAP responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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 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: true 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 minimum: 1 default: 10 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.\nSe 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.\nSe 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.\nMesmo 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/configureTenantAuthenticationDefaultRolesSettings: post: description: Cria a associação de papéis padrões para o 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: 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 schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/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 – 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: type: object allOf: – #/definitions/SAMLSettings description: Dados das configurações SAML responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/configureTenantPasswordPolicySettings: post: description: Configura a política de senha do tenant tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain – passwordPolicySettings properties: tenantDomain: type: string description: tenant para configurar politica de senha passwordPolicySettings: type: object allOf: – #/definitions/passwordPolicySettings description: Dados das configurações de política de senha responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/configureTenantOriginAccessControlSettings: post: description: Altera as configurações de controle de acesso de um tenant tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantDomain – enableOriginAccessControl properties: tenantDomain: type: string description: Domínio do tenant que deve ter as configurações de controle de acesso alteradas enableOriginAccessControl: type: boolean description: Indica se o controle de origem de acesso está habilitado trustedIpAddressesRanges: type: array items: type: object allOf: – #/definitions/ipAddressRange description: Faixas de endereços IP válidos para o controle de origem de acesso responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/changeWso2Password: post: description: NOTA: O uso dessa primitiva é restrita ao SRE e utilizada para alterar a senha do wso2 do tenant. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName – wso2Password properties: tenantName: type: string description: Nome do tenant wso2Password: type: string description: Nova senha do admin secret: true responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/publishTenantReady: post: description: Publica o evento de tenant pronto, utilize caso algum erro tenha ocorrido durante o processamento 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 force: type: boolean description: Indica se o evento deverá ser lançado mesmo se tenha sido lançado anteriormente default: false responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/actions/toggleOtpRequirement: post: description: Habilita ou desabilita a necessidade de todos os usuários do tenant precisarem configurar o OTP tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – enabled properties: enabled: type: boolean description: Indica se o OTP será ativo para todos os usuários responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tenant/signals/configureShovels: post: description: Configura o ambiente para os serviços on premises. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: string minimum: 1 description: Inquilinos para os quais o ambiente deve ser configurado. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /tenant/signals/removeShovels: post: description: Remove as configurações de shovel. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: string minimum: 1 description: Inquilinos para os quais o shovel deve ser removido responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /tenant/events/shovelConfigurationChanged: post: description: Alteração nas configurações de shovel de um tenant x-senior-event: true tags: – Events parameters: – 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: type: object allOf: – #/definitions/serviceId description: Lista de serviços instalados on premises responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tenant/events/tenantReady: post: description: Evento que indica que o tenant e todas as dependências estão prontas x-senior-event: true tags: – Events parameters: – 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 /tenant/events/tenantChanged: post: description: Evento indicando que houveram alterações no tenant x-senior-event: true tags: – Events parameters: – 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 /tenant/events/tenantReactivated: post: description: Evento indica que um tenant que estava desativado foi ativado x-senior-event: true tags: – Events parameters: – 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 /tenant/events/tenantDeactivated: post: description: Evento indica que um tenant que estava ativo foi desativado x-senior-event: true tags: – Events parameters: – 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 /tenant/events/tenantIncluded: post: description: Evento indicando que um tenant foi criado x-senior-event: true tags: – Events parameters: – 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 /tenant/events/tenantRemoved: post: description: Evento indicando que um tenant foi removido x-senior-event: true tags: – Events parameters: – 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 /tenant/events/tenantLocaleChanged: post: description: Evento indicando quando a localidade do tenant é alterada x-senior-event: true tags: – Events parameters: – 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 /tenant/events/tenantAltDomainsChanged: post: description: Evento indicando quando há alteração nos domínios alternativos do tenant x-senior-event: true tags: – Events parameters: – 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: Domínios alternativos do tenant removedAltDomains: type: array items: type: string description: Domínios alternativos removidos do tenant responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tenant/events/maintenanceStarted: post: description: Uma janela de manutenção foi iniciada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: string minimum: 1 description: Nome dos tenants que tiveram sua janela de manutenção iniciada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tenant/events/maintenanceFinished: post: description: Uma janela de manutenção foi terminada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: string minimum: 1 description: Nome dos tenants que tiveram sua janela de manutenção terminada responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: healthCheckStatus: description: Status do Healthcheck type: string enum: – UP – DOWN authType: description: Tipo de autenticação do tenant type: string enum: – G7 – G5 – LDAP – SAML testOnPremiseConnectionStage: description: Nome do teste da conexão on-premises type: string enum: – CONFIGURATION – HOST – HTTP – LOGIN – AMQP searchOperator: description: Operadores relacionais type: string enum: – EQUAL – CONTAINS – STARTS_WITH – ENDS_WITH userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT checkDTO: description: Componente avaliado no health check type: object required: – name – status properties: name: type: string description: Nome do componente status: type: string allOf: – #/definitions/healthCheckStatus description: Status do componente serviceId: description: Informações de um serviço type: object required: – domain – service properties: domain: type: string description: Nome do domínio service: type: string description: Nome do serviço shovelledServiceEvent: description: Informações do evento de um serviço que foi aplicado o shovel type: object required: – event – isInstance properties: event: type: string description: Nome do evento isInstance: type: boolean description: Indica se é um evento de instância shovelledService: description: Informações do shovel que está aplicado ao ambiente para um serviço type: object required: – domain – service – version – foundInstanceQueue – events properties: domain: type: string description: Nome do domínio service: type: string description: Nome do serviço type: string description: Versão que está aplicada foundInstanceQueue: type: boolean description: Indica se existe algum evento que é da fila de instância events: type: array items: type: object allOf: – #/definitions/shovelledServiceEvent minimum: 1 description: Eventos do serviço que tiveram as bindings aplicadas tenantBasicInfo: description: Retorna o nome e os domínios do tenant type: object required: – name – domain properties: name: type: string description: Nome do tenant domain: type: string description: Domínio do tenant altDomains: type: array items: type: string description: Domínios alternativos do tenant tenant: description: Os dados de um 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 default: false 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: type: string allOf: – #/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 format: date-time description: Data e hora em que o tenant foi desativado underMaintenance: type: boolean description: Indica que o inquilino está presente em uma janela de manutenção default: false domainAlias: type: string description: Alias do domínio do tenant tenantAlias: type: string description: Alias do nome do tenant tenantWithConfigurations: description: Todos os dados de um tenant type: object required: – name – domain – active – master – locale – adminFirstName – adminLastName – adminEmail – contacts – wso2Key – wso2Secret – multipleTokensEnabled – passwordPolicySettings – originAccessControlEnabled – otpRequirement 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 default: false 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: type: object allOf: – #/definitions/contact minimum: 1 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: type: object allOf: – #/definitions/emailSettings description: Dados das configurações SMTP 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 format: int64 description: O número de usuários limite a serem replicados antes da thread conceder lugar para outras executarem authenticationTypes: type: array items: type: string allOf: – #/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 format: int64 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.\nMesmo 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.\nSe 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,\ncontinuará a antiga.\nSe a senha do SGU for alterada após o usuário alterar na G7, passará a valer a senha do SGU novamente. default: false passwordPolicySettings: type: object allOf: – #/definitions/passwordPolicySettings description: Dados das configurações de política de senha originAccessControlEnabled: type: boolean description: Indica se o controle de origem de acesso está habilitado validIPsRange: type: array items: type: object allOf: – #/definitions/ipAddressRange description: As faixas de IPs válidos para o controle de origem de acesso ldapSettings: type: object allOf: – #/definitions/LDAPSettings description: Dados das configurações LDAP samlSettings: type: object allOf: – #/definitions/SAMLSettings description: Dados das configurações SAML 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. secret: true deactivationMoment: type: string format: date-time description: Data e hora em que o tenant foi desativado. 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 default: false tenantAlias: type: string maxLength: 255 description: Alias para o nome do tenant domainAlias: type: string maxLength: 255 description: Alias para o domínio do tenant otpRequirement: type: boolean description: Indica se a configuração OTP está habilitada para todos os usuários do tenant LDAPSettings: description: Dados das configurações LDAP de um tenant 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 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: 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` passwordPolicySettings: description: Dados das configurações de política de senha de um tenant type: object required: – minimumPasswordLength – maximumPasswordLength properties: minimumPasswordLength: type: integer format: int64 description: Quantidade mínima de caracteres da senha maximumPasswordLength: type: integer format: int64 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: type: object allOf: – #/definitions/customRecaptchaKeys description: Chaves do Google Recaptcha, quando customizado para o tenant. Quando não informado, não cadastra ou altera as chaves. customRecaptchaKeys: description: Dados de chaves do Google Recaptcha, quando customizados 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. secret: true SAMLSettings: description: Dados das configurações SAML de um tenant 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 emailSettings: description: Dados das configurações de e-mail de um tenant type: object 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 tenantProperties: description: Dados do tenant e suas propriedades 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: type: object allOf: – #/definitions/property description: Propriedades do tenant publicKeyFile: description: Arquivo de chaves públicas. 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. property: description: Propriedade type: object required: – key – value properties: key: type: string description: Nome da propriedade value: type: string description: Valor da propriedade ipAddressRange: description: Faixa de endereços IP type: object required: – startIpAddress properties: startIpAddress: type: string description: Endereço inicial da faixa de IPs endIpAddress: type: string description: Endereço final da faixa de IPs 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.\nMesmo 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: 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 contact: description: Informações de contato 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 pagination: description: As configurações de paginação de uma listagem type: object properties: pageNumber: type: integer format: int64 description: O número da página retornado. A primeira página corresponde ao índice 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página default: 10 listInformation: description: As informações sobre os resultados de listagem realizada type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Quantidade total de resultados encontrados totalPages: type: integer format: int64 description: Quantidade total de páginas encontradas 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 testOnPremiseConnectionResponse: description: Informações sobre o resultado dos testes on-premises type: object required: – stage – success properties: stage: type: string allOf: – #/definitions/testOnPremiseConnectionStage description: Nome do teste 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 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