Mais pesquisados:Customização, Tutorial, Documentação

Autorização (authorization)

1298 views 0 03/08/2020 Atualizado em 28/10/2024 integrador

2.0info: 11.1.1 Autorização description: Responsável pela autorização na plataforma G7. x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: authorization 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: /authorization/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/upDown description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Itens 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/upDown description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Itens avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/checkAccess: post: description: Para cada recurso informado, retorna se o usuário corrente possui permissão.\nSe o usuário possuir permissão e marcar para incluir os filtros, irá retornar os filtros de serviço e recurso associados. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – permissions properties: permissions: type: array items: type: object allOf: – #/definitions/permissionToCheck minimum: 1 description: As permissões à serem verificadas includeFilters: type: boolean description: Retornar os filtros de serviço e recurso associados se possuir permissão no recurso default: false includeDelegations: type: boolean description: Retornar as delegações associadas se possuir permissão no recurso default: false responses: 200: description: Ok schema: type: object required: – permissions – authorized properties: permissions: type: array items: type: object allOf: – #/definitions/checkedPermission minimum: 1 description: As permissões verificadas e seus filtros authorized: type: boolean description: Verdadeiro se o usuário possuir permissão em todos os recursos informados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /authorization/queries/getResource: post: description: Retorna os dados de um recurso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – uri properties: uri: type: string description: O identificador único do recurso responses: 200: description: Ok schema: type: object required: – resource properties: resource: type: object allOf: – #/definitions/resource description: O recurso com a URI informada 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados de um recurso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: uri description: O identificador único do recurso in: query required: true type: string responses: 200: description: Ok schema: type: object required: – resource properties: resource: type: object allOf: – #/definitions/resource description: O recurso com a URI informada 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Recurso não encontrado default: description: Error response schema: #/definitions/genericError /authorization/queries/getResources: post: description: Retorna os dados de recursos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – uris properties: uris: type: array items: type: string minimum: 1 description: Os identificadores únicos dos recursos responses: 200: description: Ok schema: type: object required: – resources properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Os recursos das URIs informadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados de recursos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: uris description: Os identificadores únicos dos recursos in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – resources properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Os recursos das URIs informadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getResourceAttributes: post: description: Retorna os atributos de recurso para utilizar no ABAC tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – uri – action properties: uri: type: string description: O identificador único do recurso action: type: string description: Nome da ação do recurso responses: 200: description: Ok schema: type: object required: – attributes properties: attributes: type: array items: type: object allOf: – #/definitions/resourceAttribute minimum: 1 description: Os atributos do recurso informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os atributos de recurso para utilizar no ABAC tags: – Queries x-senior-visibility: PRIVATE parameters: – name: uri description: O identificador único do recurso in: query required: true type: string – name: action description: Nome da ação do recurso in: query required: true type: string responses: 200: description: Ok schema: type: object required: – attributes properties: attributes: type: array items: type: object allOf: – #/definitions/resourceAttribute minimum: 1 description: Os atributos do recurso informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getResourceServices: post: description: Retorna os serviços dos recursos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/domainService minimum: 1 description: Serviços dos recursos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os serviços dos recursos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/domainService minimum: 1 description: Serviços dos recursos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/listResources: post: description: Obtém a lista de todos os recursos que a URI, nome, descrição, domínio ou serviço contenha o valor pesquisado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado nos recursos pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. role: type: string description: Nome do papel a ser utilizado no filtro responses: 200: description: Ok schema: type: object required: – resources – listInformation properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Os elementos retornados pela listagem 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 /authorization/queries/getRole: post: description: Retorna os dados de um papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: O nome do papel responses: 200: description: Ok schema: type: object required: – role properties: role: type: object allOf: – #/definitions/role description: O papel com o nome informado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Usuário(s) ou papel(s) não encontrados default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados de um papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: name description: O nome do papel in: query required: true type: string responses: 200: description: Ok schema: type: object required: – role properties: role: type: object allOf: – #/definitions/role description: O papel com o nome informado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Usuário(s) ou papel(s) não encontrados default: description: Error response schema: #/definitions/genericError /authorization/queries/findRolesByNames: post: description: Retorna os dados de papéis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – names properties: names: type: array items: type: string minimum: 1 description: Nomes dos papéis responses: 200: description: Ok schema: type: object required: – roles – notFound properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Papéis com os nomes informados notFound: type: array items: type: string minimum: 1 description: Papéis não encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados de papéis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: names description: Nomes dos papéis in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – roles – notFound properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Papéis com os nomes informados notFound: type: array items: type: string minimum: 1 description: Papéis não encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/findRolesNamesByTenant: post: description: Retorna os dados de papéis de um tenant específico. Somente tenant master tem permissão para executar essa API. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant – names properties: tenant: type: string description: Nome do tenant names: type: array items: type: string minimum: 1 description: Nomes dos papéis responses: 200: description: Ok schema: type: object required: – roles – notFound properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Papéis com os nomes informados notFound: type: array items: type: string minimum: 1 description: Papéis não encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados de papéis de um tenant específico. Somente tenant master tem permissão para executar essa API. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Nome do tenant in: query required: true type: string – name: names description: Nomes dos papéis in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – roles – notFound properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Papéis com os nomes informados notFound: type: array items: type: string minimum: 1 description: Papéis não encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/findRolesByIds: post: description: Retorna os dados de papéis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ids properties: ids: type: array items: type: string minimum: 1 description: Ids dos papéis responses: 200: description: Ok schema: type: object required: – roles – notFound properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Papéis com os ids informados notFound: type: array items: type: string minimum: 1 description: Papéis não encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados de papéis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ids description: Ids dos papéis in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – roles – notFound properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Papéis com os ids informados notFound: type: array items: type: string minimum: 1 description: Papéis não encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/listRoles: post: description: Obtém a lista de todos os papéis cujo nome contenha o valor pesquisado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no nome dos papéis pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – roles – listInformation properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Os elementos retornados pela listagem 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 /authorization/queries/listRolesByTenant: post: description: Obtém a lista de todos os papéis cujo nome contenha o valor pesquisado do tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Nome do tenant searchValue: type: string description: O valor a ser pesquisado no nome dos papéis pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – roles – listInformation properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Os elementos retornados pela listagem 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 /authorization/queries/getAssignedUsers: post: description: API DEPRECIADA: Use platform/authorization/listRoleAssignedUsers instead | DATA: 2021-10-06 | Retorna uma lista de usuários que estão vinculados em ao menos um dos papéis informados tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde os usuários estão atribuídos responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: string minimum: 1 description: Usuários vinculados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Use platform/authorization/listRoleAssignedUsers instead | DATA: 2021-10-06 | Retorna uma lista de usuários que estão vinculados em ao menos um dos papéis informados tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: roles description: Nomes dos papéis onde os usuários estão atribuídos in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: string minimum: 1 description: Usuários vinculados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getAssignedApplications: post: description: Retorna uma lista de aplicações que estão vinculados em ao menos um dos papéis informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde as aplicações estão atribuídos responses: 200: description: Ok schema: type: object required: – applications properties: applications: type: array items: type: string minimum: 1 description: Aplicações vinculados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de aplicações que estão vinculados em ao menos um dos papéis informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: roles description: Nomes dos papéis onde as aplicações estão atribuídos in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – applications properties: applications: type: array items: type: string minimum: 1 description: Aplicações vinculados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getResourceFilters: post: description: Obtém a lista de filtros disponíveis para determinado serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName properties: domainName: type: string description: Domínio pertencente do filtro serviceName: type: string description: Serviço pertencente do filtro responses: 200: description: Ok schema: type: object required: – filters properties: filters: type: array items: type: object allOf: – #/definitions/resourceFilter minimum: 1 description: Os elementos retornados pela listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a lista de filtros disponíveis para determinado serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domainName description: Domínio pertencente do filtro in: query required: true type: string – name: serviceName description: Serviço pertencente do filtro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – filters properties: filters: type: array items: type: object allOf: – #/definitions/resourceFilter minimum: 1 description: Os elementos retornados pela listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/listServicesWithFilters: post: description: Obtém a lista de domínios e serviços que contém filtros de serviço. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no nome do domínio ou serviço pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. role: type: string description: Filtro para exibir somente os domínios e serviços que possuem filtro configurado responses: 200: description: Ok schema: type: object required: – services – listInformation properties: services: type: array items: type: object allOf: – #/definitions/domainService minimum: 1 description: Os elementos retornados pela listagem 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 /authorization/queries/getServicesWithSameFilters: post: description: Obtém a lista de domínios e serviços que contém filtros de serviço com os mesmos filtros do serviço especificado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName properties: domainName: type: string description: Domínio da origem da duplicação serviceName: type: string description: Serviço de origem da duplicação responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/domainService minimum: 1 description: Os serviços que contém os mesmos filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a lista de domínios e serviços que contém filtros de serviço com os mesmos filtros do serviço especificado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domainName description: Domínio da origem da duplicação in: query required: true type: string – name: serviceName description: Serviço de origem da duplicação in: query required: true type: string responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/domainService minimum: 1 description: Os serviços que contém os mesmos filtros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/listRolesWithoutResource: post: description: Obtém a lista paginada de todos os papéis excluindo os que possuem o recurso compartilhado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – resource properties: searchValue: type: string description: O valor a ser pesquisado no nome dos papéis resource: type: string description: URI do recurso pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – roles – listInformation properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Os elementos retornados pela listagem 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 /authorization/queries/getServiceFilters: post: description: Obtém todos os filtros de serviço de um determinado serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName properties: domainName: type: string description: Restringe a pesquisa no domínio pertencente do filtro serviceName: type: string description: Restringe a pesquisa no serviço pertencente do filtro responses: 200: description: Ok schema: type: object required: – filters properties: filters: type: array items: type: object allOf: – #/definitions/serviceFilter minimum: 1 description: Os elementos retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém todos os filtros de serviço de um determinado serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domainName description: Restringe a pesquisa no domínio pertencente do filtro in: query required: true type: string – name: serviceName description: Restringe a pesquisa no serviço pertencente do filtro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – filters properties: filters: type: array items: type: object allOf: – #/definitions/serviceFilter minimum: 1 description: Os elementos retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/listPermissions: post: description: API DEPRECIADA: Use platform/authorization/listRolesPermissions instead | DATA: 2022-01-05 | Obtém a lista de todos as permissões associadas a um determinado papel tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: role: type: string description: O nome do papel com as permissões associadas roles: type: array items: type: string description: Permissões existentes em um dos papéis informados como parâmetro pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – permissions – listInformation properties: permissions: type: array items: type: object allOf: – #/definitions/permission minimum: 1 description: Os elementos retornados pela listagem 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 /authorization/queries/listRolesPermissions: post: description: Obtém a lista de todos as permissões associadas a determinados papéis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: Permissões existentes em um dos papéis informados como parâmetro pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – permissions – listInformation properties: permissions: type: array items: type: object allOf: – #/definitions/groupedPermission minimum: 1 description: Permissões dos papéis 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 /authorization/queries/getPermissions: post: description: API DEPRECIADA: Use platform/authorization/getPermissionsByService or platform/authorization/getPermissionsByResource instead | DATA: 2021-12-15 | Obtém a união das permissões vinculadas aos papéis informados, podendo filtrar por domínio e serviço ou recurso.\nÉ obrigatório que seja informado domínio e serviço ou a uri do recurso para retornar as permissões tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: O nome do papel domainName: type: string description: Nome do domínio onde as permissões estão vinculadas serviceName: type: string description: Nome do serviço onde as permissões estão vinculadas resource: type: string description: URI do recurso para qual deseja filtrar as permissões includeABAC: type: boolean description: Informa se irá retornar os scripts do tipo ABAC default: false responses: 200: description: Ok schema: type: object properties: permissions: type: array items: type: object allOf: – #/definitions/completePermission description: As permissões dos papéis unificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Use platform/authorization/getPermissionsByService or platform/authorization/getPermissionsByResource instead | DATA: 2021-12-15 | Obtém a união das permissões vinculadas aos papéis informados, podendo filtrar por domínio e serviço ou recurso.\nÉ obrigatório que seja informado domínio e serviço ou a uri do recurso para retornar as permissões tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: roles description: O nome do papel in: query required: true type: array items: type: string minimum: 1 – name: domainName description: Nome do domínio onde as permissões estão vinculadas in: query type: string – name: serviceName description: Nome do serviço onde as permissões estão vinculadas in: query type: string – name: resource description: URI do recurso para qual deseja filtrar as permissões in: query type: string – name: includeABAC description: Informa se irá retornar os scripts do tipo ABAC in: query type: boolean responses: 200: description: Ok schema: type: object properties: permissions: type: array items: type: object allOf: – #/definitions/completePermission description: As permissões dos papéis unificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getPermissionsByService: post: description: Obtém a união das permissões vinculadas aos papéis informados, filtrando pelo domínio e serviço. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles – domainName – serviceName properties: roles: type: array items: type: string minimum: 1 description: O nome do papel domainName: type: string description: Nome do domínio onde as permissões estão vinculadas serviceName: type: string description: Nome do serviço onde as permissões estão vinculadas includeABAC: type: boolean description: Informa se irá retornar os scripts do tipo ABAC default: false responses: 200: description: Ok schema: type: object properties: permissions: type: array items: type: object allOf: – #/definitions/completePermission description: As permissões dos papéis unificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a união das permissões vinculadas aos papéis informados, filtrando pelo domínio e serviço. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: roles description: O nome do papel in: query required: true type: array items: type: string minimum: 1 – name: domainName description: Nome do domínio onde as permissões estão vinculadas in: query required: true type: string – name: serviceName description: Nome do serviço onde as permissões estão vinculadas in: query required: true type: string – name: includeABAC description: Informa se irá retornar os scripts do tipo ABAC in: query type: boolean responses: 200: description: Ok schema: type: object properties: permissions: type: array items: type: object allOf: – #/definitions/completePermission description: As permissões dos papéis unificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getPermissionsByResource: post: description: Obtém a união das permissões vinculadas aos papéis informados, podendo filtrando pelo recurso. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles – resource properties: roles: type: array items: type: string minimum: 1 description: O nome do papel resource: type: string description: URI do recurso para qual deseja filtrar as permissões includeABAC: type: boolean description: Informa se irá retornar os scripts do tipo ABAC default: false responses: 200: description: Ok schema: type: object properties: permissions: type: array items: type: object allOf: – #/definitions/completePermission description: As permissões dos papéis unificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a união das permissões vinculadas aos papéis informados, podendo filtrando pelo recurso. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: roles description: O nome do papel in: query required: true type: array items: type: string minimum: 1 – name: resource description: URI do recurso para qual deseja filtrar as permissões in: query required: true type: string – name: includeABAC description: Informa se irá retornar os scripts do tipo ABAC in: query type: boolean responses: 200: description: Ok schema: type: object properties: permissions: type: array items: type: object allOf: – #/definitions/completePermission description: As permissões dos papéis unificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getPermissionsByTask: post: description: Obtém a união das permissões vincluadas aso papéis informados, filtrando pela task e papel tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles – tasks properties: roles: type: array items: type: string minimum: 1 description: Nome do papel tasks: type: array items: type: string minimum: 1 description: URI da task para qual deseja filtrar as permissões includeABAC: type: boolean description: Informa se irá retornar os scripts do tipo ABAC default: false responses: 200: description: Ok schema: type: object properties: permissions: type: array items: type: object allOf: – #/definitions/completePermission description: As permissões dos pápeis unificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a união das permissões vincluadas aso papéis informados, filtrando pela task e papel tags: – Queries x-senior-visibility: PRIVATE parameters: – name: roles description: Nome do papel in: query required: true type: array items: type: string minimum: 1 – name: tasks description: URI da task para qual deseja filtrar as permissões in: query required: true type: array items: type: string minimum: 1 – name: includeABAC description: Informa se irá retornar os scripts do tipo ABAC in: query type: boolean responses: 200: description: Ok schema: type: object properties: permissions: type: array items: type: object allOf: – #/definitions/completePermission description: As permissões dos pápeis unificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getResourcesAndPermissions: post: description: Obtém os recursos disponíveis e informa se o mesmo está vinculado ao papel.\nDê preferência para primitivas que retornam só informações necessárias como getPermissions ou listResources tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName properties: role: type: string description: O nome do papel domainName: type: string description: Nome do domínio onde os recursos estão vinculados serviceName: type: string description: Nome do serviço onde os recursos estão vinculados responses: 200: description: Ok schema: type: object properties: resources: type: array items: type: object allOf: – #/definitions/resourceAndPermission description: Os recursos disponiveís e permissões 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os recursos disponíveis e informa se o mesmo está vinculado ao papel.\nDê preferência para primitivas que retornam só informações necessárias como getPermissions ou listResources tags: – Queries x-senior-visibility: PRIVATE parameters: – name: role description: O nome do papel in: query type: string – name: domainName description: Nome do domínio onde os recursos estão vinculados in: query required: true type: string – name: serviceName description: Nome do serviço onde os recursos estão vinculados in: query required: true type: string responses: 200: description: Ok schema: type: object properties: resources: type: array items: type: object allOf: – #/definitions/resourceAndPermission description: Os recursos disponiveís e permissões 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getResourcesAndPermissionsByUris: post: description: Obtém os recursos disponíveis e informa se o mesmo está vinculado ao papel tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role – uris properties: role: type: string description: O nome do papel uris: type: array items: type: string minimum: 1 description: URIs dos resources responses: 200: description: Ok schema: type: object properties: resources: type: array items: type: object allOf: – #/definitions/resourceAndPermission description: Os recursos disponiveís e permissões 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os recursos disponíveis e informa se o mesmo está vinculado ao papel tags: – Queries x-senior-visibility: PRIVATE parameters: – name: role description: O nome do papel in: query required: true type: string – name: uris description: URIs dos resources in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object properties: resources: type: array items: type: object allOf: – #/definitions/resourceAndPermission description: Os recursos disponiveís e permissões 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getRoleFilters: post: description: Obtém a união dos filtros vinculados aos papéis informados tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – roles – domainName – serviceName properties: roles: type: array items: type: string minimum: 1 description: Lista com o nome dos papéis domainName: type: string description: Nome do domínio onde os filtros estão vinculados serviceName: type: string description: Nome do serviço onde os filtros estão vinculados responses: 200: description: Ok schema: type: object properties: filters: type: array items: type: object allOf: – #/definitions/roleServiceFilterSet description: Os filtros dos papéis unificados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Obtém a união dos filtros vinculados aos papéis informados tags: – Queries x-senior-visibility: PUBLIC parameters: – name: roles description: Lista com o nome dos papéis in: query required: true type: array items: type: string minimum: 1 – name: domainName description: Nome do domínio onde os filtros estão vinculados in: query required: true type: string – name: serviceName description: Nome do serviço onde os filtros estão vinculados in: query required: true type: string responses: 200: description: Ok schema: type: object properties: filters: type: array items: type: object allOf: – #/definitions/roleServiceFilterSet description: Os filtros dos papéis unificados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /authorization/queries/getFilterKeyRolesNamesByRoleServiceFilterValue: post: description: Obtém os papéis vinculados à abrangência de filtro informado. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – value – domainName – serviceName properties: value: type: string description: Abrangência. domainName: type: string description: Nome do domínio onde a abrangência do filtro está vinculado. serviceName: type: string description: Nome do serviço onde a abrangência do filtro está vinculado. responses: 200: description: Ok schema: type: object required: – filterKeysRolesNames properties: filterKeysRolesNames: type: array items: type: object allOf: – #/definitions/filterKeyRolesNamesMapping minimum: 1 description: papéis vinculados à abrangência de filtro. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os papéis vinculados à abrangência de filtro informado. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: value description: Abrangência. in: query required: true type: string – name: domainName description: Nome do domínio onde a abrangência do filtro está vinculado. in: query required: true type: string – name: serviceName description: Nome do serviço onde a abrangência do filtro está vinculado. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – filterKeysRolesNames properties: filterKeysRolesNames: type: array items: type: object allOf: – #/definitions/filterKeyRolesNamesMapping minimum: 1 description: papéis vinculados à abrangência de filtro. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getUserFilters: post: description: Obtém a união dos filtros vinculados ao usuário informados, sendo obrigatório filtrar por domínio e serviço. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName properties: username: type: string description: O nome do usuário. Se não for informado pegará o do contexto domainName: type: string description: Nome do domínio onde os filtros estão vinculados serviceName: type: string description: Nome do serviço onde os filtros estão vinculados responses: 200: description: Ok schema: type: object required: – filters properties: filters: type: array items: type: object allOf: – #/definitions/roleServiceFilterSet minimum: 1 description: Os filtros do usuário unificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a união dos filtros vinculados ao usuário informados, sendo obrigatório filtrar por domínio e serviço. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: username description: O nome do usuário. Se não for informado pegará o do contexto in: query type: string – name: domainName description: Nome do domínio onde os filtros estão vinculados in: query required: true type: string – name: serviceName description: Nome do serviço onde os filtros estão vinculados in: query required: true type: string responses: 200: description: Ok schema: type: object required: – filters properties: filters: type: array items: type: object allOf: – #/definitions/roleServiceFilterSet minimum: 1 description: Os filtros do usuário unificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getRoleProperties: post: description: Retorna a lista de propriedades do papel informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role properties: role: type: string description: Papel do qual se deseja obter as propriedades responses: 200: description: Ok schema: type: object properties: properties: type: array items: type: object allOf: – #/definitions/roleProperty description: Propriedades do papel informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de propriedades do papel informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: role description: Papel do qual se deseja obter as propriedades in: query required: true type: string responses: 200: description: Ok schema: type: object properties: properties: type: array items: type: object allOf: – #/definitions/roleProperty description: Propriedades do papel informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getSubstituteUsers: post: description: Retorna a lista de usuários substitutos para o usuário informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – originalUser properties: originalUser: type: string description: Username do usuário a ser substituído responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: object allOf: – #/definitions/substituteUser minimum: 1 description: Usuários que estão substituindo o usuário informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de usuários substitutos para o usuário informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: originalUser description: Username do usuário a ser substituído in: query required: true type: string responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: object allOf: – #/definitions/substituteUser minimum: 1 description: Usuários que estão substituindo o usuário informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/listSubstitutions: post: description: Obtém a lista das substituições existentes para o tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado nas substituições pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – substitutions – listInformation properties: substitutions: type: array items: type: object allOf: – #/definitions/substitution minimum: 1 description: Os elementos retornados pela listagem 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 /authorization/queries/getUserRoles: post: description: Retorna os papéis pertencentes ao usuário informado. Também é possível filtrar por serviço a ser exibido tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – user properties: user: type: string description: username do usuário service: type: object allOf: – #/definitions/domainService description: domínio/serviço do usuário responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: Nome do papeis que pertencem ao usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getUserDetailRoles: post: description: Retorna os papéis pertencentes ao usuário informado. Também é possível filtrar por serviço a ser exibido tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – user properties: user: type: string description: username do usuário service: type: object allOf: – #/definitions/domainService description: domínio/serviço do usuário responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/basicRole minimum: 1 description: Nome e descrição do papeis que pertencem ao usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getApplicationRoles: post: description: Retorna os papéis pertencentes à aplicação informada. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – application properties: application: type: string description: Nome da aplicação responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: Nome dos papeis que pertencem à aplicação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os papéis pertencentes à aplicação informada. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: application description: Nome da aplicação in: query required: true type: string responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: Nome dos papeis que pertencem à aplicação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getAllowedServices: post: description: Retorna uma lista com os serviços em que o usuário tem permissão para executar um ou mais recursos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – user properties: user: type: string description: Nome do usuário responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/domainService minimum: 1 description: Serviços em que o usuário possui permissão para algum recurso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com os serviços em que o usuário tem permissão para executar um ou mais recursos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: user description: Nome do usuário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/domainService minimum: 1 description: Serviços em que o usuário possui permissão para algum recurso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/listTasks: post: description: Obtém a lista de todas as atividades que a URI, nome, descrição, domínio ou serviço contenha o valor pesquisado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado nas atividades pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – tasks – listInformation properties: tasks: type: array items: type: object allOf: – #/definitions/task minimum: 1 description: Os elementos retornados pela listagem 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 /authorization/queries/getTask: post: description: Retorna os dados de uma atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – uri properties: uri: type: string description: O identificador único da atividade responses: 200: description: Ok schema: type: object required: – task properties: task: type: object allOf: – #/definitions/task description: A atividade com a URI informada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados de uma atividade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: uri description: O identificador único da atividade in: query required: true type: string responses: 200: description: Ok schema: type: object required: – task properties: task: type: object allOf: – #/definitions/task description: A atividade com a URI informada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getAvailableTasksForDelegation: post: description: API DEPRECIADA: Use getAvailableTasksForDelegation version 10 instead. | DATA: 2023-03-01 | Retorna as atividades do usuário corrente que estão disponíveis para serem realizadas delegação tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – tasks properties: tasks: type: array items: type: object allOf: – #/definitions/task minimum: 1 description: As atividades disponíveis para delegação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Use getAvailableTasksForDelegation version 10 instead. | DATA: 2023-03-01 | Retorna as atividades do usuário corrente que estão disponíveis para serem realizadas delegação tags: – Queries deprecated : true x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tasks properties: tasks: type: array items: type: object allOf: – #/definitions/task minimum: 1 description: As atividades disponíveis para delegação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getAvailableTasksForDelegation__10: post: description: Retorna as atividades do usuário corrente que estão disponíveis para serem realizadas delegação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado nas substituições pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – tasks – listInformation properties: tasks: type: array items: type: object allOf: – #/definitions/task minimum: 1 description: As atividades disponíveis para delegação 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 /authorization/queries/checkTaskPermissions: post: description: Retorna os recursos da atividade se o usuário corrente tiver permissão em todos eles. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – taskUri properties: taskUri: type: string description: Uri da atividade. responses: 200: description: Ok schema: type: object required: – resources – authorized properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Recursos da atividade. authorized: type: boolean description: Verdadeiro se o usuário possuir permissão em todos os recursos da atividade. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os recursos da atividade se o usuário corrente tiver permissão em todos eles. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: taskUri description: Uri da atividade. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – resources – authorized properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Recursos da atividade. authorized: type: boolean description: Verdadeiro se o usuário possuir permissão em todos os recursos da atividade. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/listDelegations: post: description: Lista de forma paginada as delegações que o usuário tem acesso tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchValue: type: string description: O valor a ser pesquisado no campo label e descrição da atividade from: type: string format: date description: Data inicial do período. Retorna as delegações onde o período da delegação é igual ou maior que a data informada. to: type: string format: date description: Data final do período. Retorna as delegações onde o período da delegação é igual ou menor que a data informada. originUser: type: string description: Usuário que realizou a delegação targetUser: type: string description: Usuário que recebeu a delegação status: type: string allOf: – #/definitions/delegationStatus description: Status da delegação. Se omitido trará todos. pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – delegations – listInformation properties: delegations: type: array items: type: object allOf: – #/definitions/delegation minimum: 1 description: Os elementos retornados pela listagem 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 /authorization/queries/getAllowedResources: post: description: Retorna os recursos que o usuário possui acesso, deverá ser filtrado pela uri do recurso ou por um domínio/serviço específico.\nPara verificar informações de outro usuário, será necessário permissão no recurso res://senior.com.br/platform/authorization/role tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: user: type: string description: Se não informado será utilizado o do contexto resources: type: array items: type: string description: Identificadores dos recursos, se informado, o filtro de domínio e serviço será desconsiderado domainService: type: object allOf: – #/definitions/domainService description: Domínio/serviço em que os recursos pertencem responses: 200: description: Ok schema: type: object required: – permission properties: permission: type: array items: type: object allOf: – #/definitions/ownerPermission minimum: 1 description: As permissões do usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getPermissionsRoles: post: description: Retorna os papéis que estão vinculado as permissões solicitadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – permissions properties: permissions: type: array items: type: object allOf: – #/definitions/permission minimum: 1 description: Conjunto de recurso + ação responses: 200: description: Ok schema: type: object required: – permissionsRoles properties: permissionsRoles: type: array items: type: object allOf: – #/definitions/permissionRoles minimum: 1 description: As permissões e a lista de papéis vinculados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getAllowedUsers: post: description: Retorna os usuários que estão vinculados as permissões solicitadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – permissions properties: permissions: type: array items: type: object allOf: – #/definitions/permission minimum: 1 description: Conjunto de recurso + ação responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: object allOf: – #/definitions/userInfo minimum: 1 description: Os usuários vinculados as permissões 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/getSubstitutions: post: description: Retorna uma lista de usuários substitutos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – permissions properties: permissions: type: array items: type: object allOf: – #/definitions/permission minimum: 1 description: Conjunto de permissões (resource, ação) originalUser: type: string description: Usuário titular responses: 200: description: Ok schema: type: object required: – resourceSubstitution properties: resourceSubstitution: type: array items: type: object allOf: – #/definitions/resourceSubstitution minimum: 1 description: Retorna uma lista com os recursos pesquisados e os usuários susbstitutos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/queries/listRoleAssignedUsers: post: description: Lista de forma paginada os usuários associados a um papel tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role properties: role: type: string description: Nome do papel pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. blockedUsers: type: boolean description: Se deverá incluir usuários bloqueados na listagem responses: 200: description: Ok schema: type: object required: – users – listInformation properties: users: type: array items: type: object allOf: – #/definitions/roleUser minimum: 1 description: Os elementos retornados pela listagem 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 /authorization/queries/listRoleUsers: post: description: Lista de forma paginada os usuários que são ou podem ser associados a um papel tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role properties: role: type: string description: Nome do papel pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação da listagem. Não definido, retornará os 10 primeiros resultados. blockedUsers: type: boolean description: Se deverá incluir usuários bloqueados na listagem searchValue: type: string description: Termo para filtrar a lista de usuários (não permitido usar em conjunto com onlyAssignedUsers) responses: 200: description: Ok schema: type: object required: – users – listInformation properties: users: type: array items: type: object allOf: – #/definitions/roleUser minimum: 1 description: Os elementos retornados pela listagem 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 /authorization/queries/getRoleIntegrations: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role properties: role: type: string description: Nome do papel responses: 200: description: Ok schema: type: object properties: managedBy: type: array items: type: string allOf: – #/definitions/integrationType description: Quais tipos de integração podem realizar alterações no papel integrations: type: array items: type: object allOf: – #/definitions/integration description: Informações de integração do papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: role description: Nome do papel in: query required: true type: string responses: 200: description: Ok schema: type: object properties: managedBy: type: array items: type: string allOf: – #/definitions/integrationType description: Quais tipos de integração podem realizar alterações no papel integrations: type: array items: type: object allOf: – #/definitions/integration description: Informações de integração do papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/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 /authorization/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 /authorization/actions/assignUsers: post: description: API DEPRECIADA: Use platform/authorization/assignUsers__11 instead | DATA: 2024-09-09 | Vincula um ou mais usuários à um ou mais papéis, lançando o evento rolePermissionsChanged com os usuários incluídos tags: – Actions deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – roles – users properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde os usuários serão atribuídos users: type: array items: type: string minimum: 1 description: Os usuário à serem incluídos nos papéis responses: 200: description: Ok schema: type: object required: – changedAssignments properties: changedAssignments: type: boolean description: Indica se houve alguma alteração feita.\nSe algum dos usuários foi associado a algum dos papéis, retorna true.\nSe todos os usuários já estavam associados a todos os papéis, retorna false. 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: papel(s) não encontrados default: description: Error response schema: #/definitions/genericError /authorization/actions/assignUsers__11: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – roles – users properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde os usuários serão atribuídos users: type: array items: type: string minimum: 1 description: Os usuário à serem incluídos nos papéis responses: 200: description: Ok schema: type: object required: – changedAssignments properties: changedAssignments: type: boolean description: Indica se houve alguma alteração feita.\nSe algum dos usuários foi associado a algum dos papéis, retorna true.\nSe todos os usuários já estavam associados a todos os papéis, retorna false.\nSe algum usuário não existe retorna a lista de usuários que não foram encontrados. usersNotFound: type: array items: type: string description: 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Usuário(s) ou papel(s) não encontrados default: description: Error response schema: #/definitions/genericError /authorization/actions/unassignUsers: post: description: API DEPRECIADA: Use platform/authorization/unassignUsers__11 instead | DATA: 2024-09-09 | Remove um ou mais usuários de um ou mais papéis, lançando o evento rolePermissionsChanged com os usuários removidos tags: – Actions deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – roles – users properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde os usuários serão removidos users: type: array items: type: string minimum: 1 description: Os usuário à serem removidos dos papéis responses: 200: description: Ok schema: type: object required: – changedAssignments properties: changedAssignments: type: boolean description: Indica se houve alguma alteração feita.\nSe algum dos usuários foi desassiciado de algum dos papéis, retorna true.\nSe todos os usuários já estavam desassociados de todos os papéis, retorna false. 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: papel(s) não encontrados default: description: Error response schema: #/definitions/genericError /authorization/actions/unassignUsers__11: post: description: Remove um ou mais usuários de um ou mais papéis, lançando o evento rolePermissionsChanged com os usuários removidos tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – roles – users properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde os usuários serão removidos users: type: array items: type: string minimum: 1 description: Os usuário à serem removidos dos papéis responses: 200: description: Ok schema: type: object required: – changedAssignments properties: changedAssignments: type: boolean description: Indica se houve alguma alteração feita.\nSe algum dos usuários foi desassiciado de algum dos papéis, retorna true.\nSe todos os usuários já estavam desassociados de todos os papéis, retorna false.\nSe algum usuário não existe retorna a lista de usuários que não foram encontrados. usersNotFound: type: array items: type: string description: 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Usuário(s) ou papel(s) não encontrados default: description: Error response schema: #/definitions/genericError /authorization/actions/assignAllUsers: post: description: Vincula todos os usuários à um ou mais papéis, lançando o evento rolePermissionsChanged com os usuários incluídos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: Nome dos papéis onde os usuários serão atribuídos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/unassignAllUsers: post: description: Remove todos os usuários de um ou mais papéis, lançando o evento rolePermissionsChanged com os usuários removidos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: Nome dos papéis onde os usuários serão removidos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/reassignUsers: post: description: Vincula ou remove um ou mais usuários à um ou mais papéis, lançando o evento rolePermissionsChanged com os usuários incluídos e removidos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde os usuários serão atribuídos toAssign: type: array items: type: string description: Os usuários à serem incluídos nos papéis toUnassign: type: array items: type: string description: Os usuários à serem removidos dos papéis responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/reassignApplications: post: description: Vincula ou remove uma ou mais aplicações à um ou mais papéis, lançando o evento rolePermissionsChanged com as aplicações incluídas e removidas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde as aplicações serão atribuídos toAssign: type: array items: type: string description: As aplicações à serem incluídas nos papéis toUnassign: type: array items: type: string description: As aplicações à serem removidas dos papéis responses: 200: description: Ok schema: type: object required: – reassigned properties: reassigned: type: array items: type: object allOf: – #/definitions/reassigned minimum: 1 description: Lista com os papéis e aplicações que foram associadas e desassociadas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/assignPermissionsToRole: post: description: API DEPRECIADA: Use platform/authorization/grantPermissions instead | DATA: 2021-08-22 | Adiciona permissões (conjunto de recurso/ação) para um determinado papel.\nPermissões que já estão adicionadas ao papel são silenciosamente ignoradas.\nLança o evento rolePermissionsChanged com as alterações efetuadas. tags: – Actions deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role – permissions properties: role: type: string description: O nome do papel onde os recursos serão atribuídos permissions: type: array items: type: object allOf: – #/definitions/completePermission minimum: 1 description: O conjunto de permissões a serem adicionados ao papel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/unassignPermissionsToRole: post: description: API DEPRECIADA: Use platform/authorization/revokePermissions instead | DATA: 2021-08-22 | Remove permissões (conjunto de recurso/ação) de um determinado papel.\nPermissões que não estão adicionadas ao papel são silenciosamente ignoradas.\nLança o evento rolePermissionsChanged com as alterações efetuadas. tags: – Actions deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role – permissions properties: role: type: string description: O nome do papel de onde os recursos serão removidos permissions: type: array items: type: object allOf: – #/definitions/permission minimum: 1 description: O conjunto de permissões a serem removidas do papel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/grantPermissions: post: description: Adiciona permissões (conjunto de recurso/ação) à um ou mais papéis.\nPermissões que já estão adicionadas ao papel são silenciosamente ignoradas.\nLança o evento rolePermissionsChanged com as alterações efetuadas. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles – permissions properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde os recursos serão atribuídos permissions: type: array items: type: object allOf: – #/definitions/completePermission minimum: 1 description: O conjunto de permissões a serem adicionados ao papel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/revokePermissions: post: description: Remove permissões (conjunto de recurso/ação) de um ou mais papéis.\nPermissões que não estão adicionadas ao papel são silenciosamente ignoradas.\nLança o evento rolePermissionsChanged com as alterações efetuadas. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles – permissions properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde os recursos serão removidos permissions: type: array items: type: object allOf: – #/definitions/permission minimum: 1 description: O conjunto de permissões a serem removidas do papel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/savePermissions: post: description: Adiciona e remove as permissões de um ou mais papéis.\nLança o evento rolePermissionsChanged somente com as alterações efetuadas.\n- Ignora silenciosamente a não existência ou duplicidade de um registro\n- Ignora silenciosamente a referência de um recurso se ele estiver bloqueado na shared tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde os recursos serão adicionando ou removidos toGrant: type: array items: type: object allOf: – #/definitions/completePermission description: O conjunto de permissões a serem adicionadas ao papel toRevoke: type: array items: type: object allOf: – #/definitions/permission description: O conjunto de permissões a serem removidas do papel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/createRoleFilters: post: description: Adiciona conjunto de filtros para um ou mais papéis.\nUm conjunto de filtros é dado pela chave de domínio, serviço e sequência (agrupador).\nUm conjunto enviado substitui totalmente outro conjunto.\nLança o evento rolePermissionsChanged com as alterações efetuadas. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles – filters properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde os filtros serão atribuídos filters: type: array items: type: object allOf: – #/definitions/roleServiceFilterSet minimum: 1 description: O conjunto de filtros a serem adicionados ao papel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/deleteRoleFilters: post: description: Remove conjuntos de filtros de um ou mais papéis.\nConjuntos de filtros que não estão adicionados ao papel são silenciosamente ignorados.\nUm conjunto de filtros é dado pela chave de domínio, serviço e sequência (agrupador).\nLança o evento rolePermissionsChanged com as alterações efetuadas, e também roleServiceFilterDeleted\ncom as deleções realizadas. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles – filters properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde os filtros serão removidos filters: type: array items: type: object allOf: – #/definitions/roleServiceFilterKey minimum: 1 description: O conjunto de permissões a serem removidas do papel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/saveRoleFilters: post: description: Adiciona e remove conjuntos de filtros de um ou mais papéis.\nUm conjunto de filtros é dado pela chave de domínio, serviço e sequência (agrupador).\nLança o evento rolePermissionsChanged somente com as alterações efetuadas.\nIgnora silenciosamente a não existência ou duplicidade de um conjunto de filtros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: Nomes dos papéis onde os filtros serão adicionando ou removidos toCreate: type: array items: type: object allOf: – #/definitions/roleServiceFilterSet description: O conjunto de filtros a serem adicionados ao papel ou atualizados toDelete: type: array items: type: object allOf: – #/definitions/roleServiceFilterKey description: O conjunto de filtros a serem removidas do papel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/createResources: post: description: API DEPRECIADA: Use platform/authorization/saveResources instead | DATA: 2021-08-22 | Cria recursos tags: – Actions deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – resources properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Recursos que devem ser criados responses: 200: description: Ok schema: type: object required: – resources properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Retorna os dados dos recursos criados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/saveResources: post: description: Cria ou atualiza recursos juntamente com suas ações.\nRecursos e ações que já existirem são atualizados, ações que já existirem no recurso são mantidas.\nCampos omitidos ou vazios serão ignorados.\nO campo nome do recurso é obrigatório na criação de um novo recurso.\nSó serão permitidas alterações em recursos customizados. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – resources properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Recursos que devem ser criados.\nÉ possível utilizar o registro ownerResource para criar um recurso com um usuário como proprietário, informando o nome do usuário. responses: 200: description: Ok schema: type: object required: – resources properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Retorna os dados dos recursos criados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados, campo informado incorretamente, não pode remover recurso ou recurso não tem qualque ação 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /authorization/actions/deleteResources: post: description: Deleta recursos juntamente com suas ações.\nSomente é possível remover recursos customizados tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – resources properties: resources: type: array items: type: string minimum: 1 description: Identificadores dos recursos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou somente recursos customizados podem ser excluídos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /authorization/actions/deleteResourceActions: post: description: Deleta as ações de um determinado recurso, removendo todas as permissões vinculadas.\nSomente é possível remover ações de recursos customizados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – resource – actions properties: resource: type: string description: Identificador do recurso actions: type: array items: type: string minimum: 1 description: Nome das ações que serão removidas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/saveSharedResources: post: description: Cria ou atualiza recursos juntamente com suas ações no schema shared.\nRecursos e ações que já existirem são atualizados, ações que já existirem no recurso são mantidas.\nCampos omitidos ou vazios serão ignorados.\nO campo nome do recurso é obrigatório na criação de um novo recurso. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – resources properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Recursos que devem ser criados. responses: 200: description: Ok schema: type: object required: – resources properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Retorna os dados dos recursos criados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados, campo informado incorretamente, não pode remover recurso ou recurso não tem qualquer ação 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /authorization/actions/createRole: post: description: Cria um novo papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string maxLength: 255 description: O nome do papel description: type: string maxLength: 255 description: A descrição do papel responses: 200: description: Ok schema: type: object required: – name properties: name: type: string maxLength: 255 description: Retorna o nome do papel criado, quem estiver adicionando o papel,\npode obter todos os dados pelo name 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /authorization/actions/duplicateRole: post: description: Duplica um papel existente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role – name properties: role: type: string maxLength: 255 description: Nome do papel a ser duplicado name: type: string maxLength: 255 description: Nome do papel que será criado a partir do papel original description: type: string maxLength: 255 description: Descrição do papel que será criado a partir do papel original responses: 200: description: Ok schema: type: object required: – name properties: name: type: string maxLength: 255 description: Retorna o nome do papel duplicado, quem estiver duplicando o papel,\npode obter todos os dados pelo name 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/updateRole: post: description: Atualiza um papel já existente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – oldName properties: oldName: type: string maxLength: 255 description: O nome antigo do papel newName: type: string maxLength: 255 description: O novo nome do papel description: type: string maxLength: 255 description: A descrição do papel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/createRoleProperties: post: description: Adiciona as propriedades informadas ao papel. Se alguma propriedade existir a primitiva lançará exceção e não criará nenhuma propriedade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role – properties properties: role: type: string description: Papel no qual se deseja adiciona as propriedades properties: type: array items: type: object allOf: – #/definitions/roleProperty minimum: 1 description: Propriedades a serem adicionadas no papel responses: 200: description: Ok schema: type: object required: – role properties: role: type: string description: Retorna o papel, pode obter os papeis pela role 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/deleteRoleProperties: post: description: Remove as propriedades informadas para o papel. Propriedades que não existirem serão ignoradas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role – properties properties: role: type: string description: Papel que terá as propriedades removidas properties: type: array items: type: string minimum: 1 description: Chave das propriedades que se deseja remover responses: 200: description: Ok schema: type: object required: – properties properties: properties: type: array items: type: string minimum: 1 description: Propriedades que foram removidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/saveRoleProperties: post: description: Salva as propriedades no papel. As propriedades a serem removidas são executadas primeiro.\nCaso propriedade exista na lista de remoção e adição a primitiva irá remover a propriedade e adiciona-lá novamente na sequência.\nSe uma propriedade a ser incluída na base de dados já existir ela será atualizada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role properties: role: type: string description: Papel onde devem ser salvas as propriedades toDelete: type: array items: type: string description: Propriedades a serem removidas toCreate: type: array items: type: object allOf: – #/definitions/roleProperty description: Propriedades a serem criadas responses: 200: description: Ok schema: type: object required: – role properties: role: type: string description: Retorna o papel, pode obter os papeis pela role 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/deleteRole: post: description: Deleta um papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome do papel a ser deletado responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Papel não encontrado default: description: Error response schema: #/definitions/genericError /authorization/actions/createSubstitution: post: description: Cria uma substituição para um usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/substitution responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/deleteSubstitution: post: description: Remove uma substituição já existente. Os parâmetros informados devem ser iguais aos da criação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – originalUser – from – to properties: originalUser: type: string description: Username do usuário substituído from: type: string format: date description: Data de início da subsituição to: type: string format: date description: Data de término da substituição responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/saveSubstitution: post: description: Salva uma substituição. Se a substituição não existia ela será criada, se já existia será atualizada. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – originalUser – from – to properties: originalUser: type: string description: Username do usuário a substituído from: type: string format: date description: Data de início da substituição to: type: string format: date description: Data de término da subsituição timezoneOffset: type: integer format: int64 description: Offset do timezone em minutos para tratar a data de início da substituição. Ex: -180 (GMT -03:00). Se não informado, será levado em consideração o timezone do servidor (0 – UTC). default: 0 toAdd: type: array items: type: object allOf: – #/definitions/substituteUser description: Usuários substitutos a serem adicionados toDelete: type: array items: type: object allOf: – #/definitions/substituteUser description: Usuários substitutos a serem removidos reason: type: string maxLength: 1000 description: Razão pela qual a substituição está sendo feita responses: 200: description: Ok schema: type: object required: – originalUser properties: originalUser: type: string description: Retorna o username do usuário a substituído 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/getDelegation: post: description: Obtém os dados de uma delegação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – delegationId properties: delegationId: type: string description: O identificador da delegação responses: 200: description: Ok schema: type: object required: – delegation properties: delegation: type: object allOf: – #/definitions/delegation description: Os dados da delegação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/saveDelegation: post: description: Salva uma delegação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – taskUri – targetUser – from – to – permissions properties: reason: type: string description: Descrição do motivo da delegação taskUri: type: string description: O identificador da atividade da delegação targetUser: type: string description: Usuário que receberá a delegação from: type: string format: date description: Data de início da delegação. Ela deve ser anterior ou igual a data de término e deve ser igual ou maior que a data atual. to: type: string format: date description: Data de término da delegação. Ela deve ser igual ou posterior a data de início. permissions: type: array items: type: object allOf: – #/definitions/permission minimum: 1 description: As permissões da atividade que serão delegadas includeFilters: type: boolean description: Se a delegeção também incluirá os filtros de serviço e recurso associados ao usuário de origem default: false responses: 200: description: Ok schema: type: object required: – delegationId properties: delegationId: type: string description: O identificador da delegação criada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/deleteDelegations: post: description: Remove uma ou mais delegações tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – delegationIds properties: delegationIds: type: array items: type: string minimum: 1 description: Os identificadores das delegações que deverão ser excluídas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/synchronizeLDAPRoles: post: description: Realiza a sincronização de papéis do tenant corrente com um servidor LDAP. Os papéis sincronizados são assinalados como obtidos pelo LDAP.\nA cada sincronização os papéis anteriormente obtidos pelo LDAP que não foram sincronizados novamente são removidos.\nOs dados da conexão com o servidor LDAP são obtidos através das informações do tenant. tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/executeG5RoleIntegration: post: description: Executa os comandos de integração de papéis da G5 tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – toIntegrate properties: toIntegrate: type: array items: type: object allOf: – #/definitions/g5Role minimum: 1 description: Todos os eventos de integração de papel à serem executados na sequência da lista responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/saveLockStatus: post: description: Permite bloquear ou desbloquear recursos por domínio, domínio e serviço, recursos ou atividades.\nNecessário permissão master no recurso/ação res://senior.com.br/platform/authorization/lock_unlock / Save.\nAs últimas ações tem prioridade sobre as anteriores.\nExemplo: Bloquear todos os serviços do hcm com exceção do analytics\n[\n{ locked: true, domain: hcm },\n{ locked: false, domain: hcm, service: analytics }\n] tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – toSave properties: tenant: type: string description: toSave: type: array items: type: object allOf: – #/definitions/lock minimum: 1 description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/shareResource: post: description: Permite o proprietário de um recurso dar acesso a algum outro usuário. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – resource – actions – users properties: resource: type: string description: Identificador do recurso actions: type: array items: type: string minimum: 1 description: Nome das ações que serão atribuídas users: type: array items: type: string minimum: 1 description: Nome dos usuários com domínio owner: type: boolean description: Identifica se o usuário receberá a permissão de proprietário default: false responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/unshareResource: post: description: Permite o proprietário de um recurso revogar acesso a determinado usuário.\nA revogação não inclui a remoção do recurso dos papéis que estiverem vinculados. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – resource – actions – users properties: resource: type: string description: Identificador do recurso actions: type: array items: type: string minimum: 1 description: Nome das ações que serão revogadas users: type: array items: type: string minimum: 1 description: Nome dos usuários com domínio responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/actions/saveRoleIntegrations: post: description: Persiste as informações de integração do papel tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role properties: role: type: string description: Nome do papel managedBy: type: array items: type: string allOf: – #/definitions/integrationType description: Quais tipos de integração podem realizar alterações no papel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /authorization/signals/replicateServiceFilters: post: description: Replica os valores de campos de filtro (abrangência) de um papel e serviço para outros serviços.\nCaso existam outros valores configurados anteriormente nos serviços de destino esses valores serão\napagados, ao final do processo todos os serviços de destino vão possuir exatamente os mesmos valores\ndo serviço de origem para o papel informado. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – source – target – role properties: source: type: object allOf: – #/definitions/domainService description: Domínio e serviço da origem da duplicação target: type: array items: type: object allOf: – #/definitions/domainService minimum: 1 description: Domínio e serviço de destino da duplicação role: type: string description: Nome do papel responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /authorization/signals/refreshResources: post: description: Atualiza os recursos e filtros de um tenant, podendo restringir a um serviço específico.\nSe um erro ocorrer em um dos serviços este é ignorado e notificado ao fim\nEsta operação destrói os vínculos com o papel de recursos ou filtros excluídos, em exceção quando\nocorrer um preenchimento incorreto de alguma entidade existente. tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: O tenant que terá seus recursos atualizados, se omitido, domainService é obrigatório domainService: type: object allOf: – #/definitions/domainService description: O serviço que terá seus recursos atualizados, se omitido irá atualizar todos os recursos de tenant, tornando o campo obrigatório responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /authorization/signals/clearResourcesDeadReferences: post: description: Limpa as referências não utilizadas dos recursos/filtros compartilhados de um ou mais tenants, com o objetivo de manter a base consistente. Se um erro ocorrer este é ignorado e notificado ao fim tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: tenants: type: array items: type: string description: Tenants nos quais terão as suas referências não utilizadas removidas. Se omitido, limpará para todos os tenants responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /authorization/signals/clearExcludedUsers: post: description: Remove usuários que foram marcados para exclusão tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: Nome do tenant responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /authorization/signals/publishRolePermissionsChanged: post: description: Sinal para publicação do evento de permissão alterada através do serviço legado tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – role properties: role: type: string description: O nome do papel que teve as permissões alteradas permissionsIncluded: type: array items: type: object allOf: – #/definitions/permission description: As permissões incluídas no papel permissionsExcluded: type: array items: type: object allOf: – #/definitions/permission description: As permissões excluídas do papel filtersIncluded: type: array items: type: object allOf: – #/definitions/roleServiceFilterKey description: Os conjuntos de filtros que foram incluídos filtersExcluded: type: array items: type: object allOf: – #/definitions/roleServiceFilterKey description: Os conjuntos de filtros que foram excluídos usersIncluded: type: array items: type: string description: Usuários incluídos usersExcluded: type: array items: type: string description: Usuários excluídos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /authorization/signals/publishRoleCreated: post: description: Permitido apenas pelo authorization legacy\nSinal para publicação do evento de criação de um novo papel.\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /authorization/signals/publishRoleNameChanged: post: description: Permitido apenas pelo authorization legacy\nSinal para publicação do evento de alteração do nome de um papel.\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/roleChanged minimum: 1 description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /authorization/signals/publishRoleDeleted: post: description: Permitido apenas pelo authorization legacy\nSinal para publicação do evento de papel excluído\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /authorization/events/rolePermissionsChanged: post: description: Notifica quando um papel teve suas informações de permissão e/ou filtros alteradas x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – role properties: role: type: string description: O nome do papel que teve as permissões alteradas permissionsIncluded: type: array items: type: object allOf: – #/definitions/permission description: As permissões incluídas no papel permissionsExcluded: type: array items: type: object allOf: – #/definitions/permission description: As permissões excluídas do papel filtersIncluded: type: array items: type: object allOf: – #/definitions/roleServiceFilterKey description: Os conjuntos de filtros que foram incluídos filtersExcluded: type: array items: type: object allOf: – #/definitions/roleServiceFilterKey description: Os conjuntos de filtros que foram excluídos usersIncluded: type: array items: type: string description: Usuários incluídos usersExcluded: type: array items: type: string description: Usuários excluídos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /authorization/events/delegationsChanged: post: description: Notifica quando uma ou mais delegações foram incluídas/alteradas/removidas x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – changes properties: changes: type: array items: type: object allOf: – #/definitions/delegationChanged minimum: 1 description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /authorization/events/resourcesLoaded: post: description: Notifica após uma tentativa de carregar ou atualizar os recursos x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: Nome do tenant caso a solicitação de atualização tenha ocorrido somente para o mesmo.\nEste campo não é informado quando a atualização seguir o curso normal para todos da nuvem. domainService: type: object allOf: – #/definitions/domainService description: Domínio e serviço carregado.\nEste campo não é informado quando trata-se de uma criação de tenant ou é solicitada a atualização de todos os serviços da plataforma responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /authorization/events/roleCreated: post: description: Notifica quando uma nova role é criada. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /authorization/events/roleNameChanged: post: description: Notifica quando o nome de um papel é alterado. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/roleChanged minimum: 1 description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /authorization/events/roleDeleted: post: description: Notifica quando um papel é removido. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – roles properties: roles: type: array items: type: string minimum: 1 description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /authorization/events/resourcesCreated: post: description: Notifica quando um ou mais recursos são criados. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – resources properties: resources: type: array items: type: object allOf: – #/definitions/permission minimum: 1 description: Lista com os recursos que foram criados tenant: type: string description: Tenant no qual os recursos foram criados. Será nulo se os recursos forem compartilhados entre tenants. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /authorization/events/resourcesDeleted: post: description: Notifica quando um ou mais recursos são deletados. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – resources properties: resources: type: array items: type: object allOf: – #/definitions/permission minimum: 1 description: Lista com os recursos que foram deletados tenant: type: string description: Tenant no qual os recursos foram deletados. Será nulo se os recursos forem compartilhados entre tenants. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /authorization/events/roleServiceFilterDeleted: post: description: Sinal para publicação de evento de deleção de filtros de papéis de um serviço. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – filterKeyRolesNames properties: filterKeyRolesNames: type: object allOf: – #/definitions/filterKeyRolesNamesMapping description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: type: string enum: – UP – DOWN delegationStatus: description: type: string enum: – ACTIVE – PENDING – DELETED – COMPLETED integrationType: description: Tipo de integração type: string enum: – G5 – LDAP 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 checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck basicRole: description: Retorna informações referente aos papéis do usuário type: object required: – id – name – description properties: id: type: string description: Identificação do papel name: type: string description: Nome do papel description: type: string description: Descrição do papel reassigned: description: Resultado da associação e desassociação de usuários em um papel type: object required: – role – assigned – unassigned properties: role: type: string description: Nome do papel assigned: type: array items: type: string minimum: 1 description: Lista com os nomes das aplicações que foram associadas unassigned: type: array items: type: string minimum: 1 description: Lista com as nomes das aplicações que foram desassociadas permissionToCheck: description: Conjunto de recurso, ação e atributos para validação da permissão type: object required: – resource – action properties: resource: type: string description: URI do recurso action: type: string description: Ação do recurso attributes: type: array items: type: object allOf: – #/definitions/attributeValue description: Atributos ABAC à serem utilizados no script (se houver) checkedPermission: description: Resultado da verificação de permissão type: object required: – resource – action – authorized – serviceFilters – resourceFilters – delegations properties: resource: type: string description: URI do recurso action: type: string description: Ação do recurso authorized: type: boolean description: Se o usuário possui permissão owner: type: boolean description: Identifica se a permissão foi dada por ser proprietário default: false serviceFilters: type: array items: type: object allOf: – #/definitions/roleServiceFilterSet minimum: 1 description: Os filtros de serviço existentes para o domínio e serviço do recurso (somente se houver permissão) resourceFilters: type: array items: type: string minimum: 1 description: Os filtros existentes do recurso (somente se houver permissão) delegations: type: array items: type: object allOf: – #/definitions/delegation minimum: 1 description: As delegações que referenciam esse recurso (somente se houver permissão) attributeValue: description: Conjunto do atributo e valor a ser utilizado no ABAC da verificação de permissão type: object required: – attribute – value properties: attribute: type: string description: Nome do atributo value: type: string description: Valor do atributo resource: description: Um recurso é um elemento que deve ter seu acesso controlado pelo serviço de autorização discriminator: _discriminator type: object required: – uri – actions – _discriminator properties: uri: type: string maxLength: 255 description: O identificador único do recurso, seguindo o padrão para novos recursos: res://dominio_tenant/custom/nome_servico/nome_recurso name: type: string maxLength: 255 description: Nome do recurso label: type: string maxLength: 255 description: Chave de tradução para o nome do recurso description: type: string maxLength: 255 description: Chave de tradução para a descrição do recurso actions: type: array items: type: object allOf: – #/definitions/action minimum: 1 description: As ações associadas ao recurso domainName: type: string maxLength: 255 description: Domínio pertencente do recurso serviceName: type: string maxLength: 255 description: Serviço pertencente do recurso _discriminator: type: string description: ownerResource: description: Recurso onde este deverá possuir um usuário como proprietário allOf: – #/definitions/resource – type: object required: – user properties: user: type: string maxLength: 255 description: Nome do usuário completo com domínio action: description: Uma ação de um recurso type: object required: – name properties: name: type: string maxLength: 100 description: Nome da ação label: type: string maxLength: 255 description: Chave de tradução para o nome da ação master: type: boolean description: Indica se a ação pode ser somente utilizada por tenants master hasAttributes: type: boolean description: Informação se a ação possui atributos, somente consulta locked: type: boolean description: Informa se a ação está bloqueada default: false resourceAttribute: description: Atributos do recurso utilizado pelo ABAC type: object required: – name properties: name: type: string description: Nome do atributo label: type: string description: Chave de tradução para o nome do atributo description: type: string description: Chave de tradução para a descrição do atributo role: description: Um papel de usuário type: object required: – name – description properties: name: type: string description: Nome único do papel description: type: string description: Descrição do papel resourceAndPermission: description: Registro que contém os recursos disponíveis e se possui permissão type: object required: – uri – actions properties: uri: type: string maxLength: 255 description: O identificador único do recurso, seguindo o padrão para novos recursos: res://dominio_tenant/custom/nome_servico/nome_recurso name: type: string maxLength: 255 description: Nome do recurso label: type: string maxLength: 255 description: Chave de tradução para o nome do recurso description: type: string maxLength: 255 description: Chave de tradução para a descrição do recurso actions: type: array items: type: object allOf: – #/definitions/resourceAndPermissionAction minimum: 1 description: As ações associadas ao recurso resourceAndPermissionAction: description: Uma ação de um recurso e se há permissão type: object required: – name – allowed properties: name: type: string maxLength: 100 description: Nome da ação label: type: string maxLength: 255 description: Chave de tradução para o nome da ação master: type: boolean description: Indica se a ação pode ser somente utilizada por tenants master hasAttributes: type: boolean description: Informação se a ação possui atributos, somente consulta allowed: type: boolean description: Se possui permissão script: type: string description: Script Javascript para validação de permissão do tipo ABAC filters: type: array items: type: string description: Filtros de recursos ativos (campo uri) para esta permissão, sobrescreve todos filtros por este parâmetro locked: type: boolean description: Informa se o recurso/ação está bloqueado default: false permission: description: Um conjunto de resource e ação discriminator: _discriminator type: object required: – resource – action – _discriminator properties: resource: type: string maxLength: 255 description: O uri do resource action: type: string description: O nome da ação _discriminator: type: string description: groupedPermission: description: Um conjunto de resource e ações type: object required: – resource – actions properties: resource: type: string maxLength: 255 description: O uri do resource actions: type: array items: type: string minimum: 1 description: Os nomes das ações ownerPermission: description: Um conjunto de resource e ação e se é proprietário allOf: – #/definitions/permission – type: object required: – owner properties: owner: type: boolean description: Identifica se o usuário é proprietário do recurso completePermission: description: Um conjunto de resource, ação e filtros allOf: – #/definitions/permission – type: object properties: script: type: string description: Script Javascript para validação de permissão do tipo ABAC filters: type: array items: type: string description: Filtros de recursos ativos (campo uri) para esta permissão, sobrescreve todos filtros por este parâmetro resourceFilter: description: Filtros de um serviço que serão vinculados à ação de um recurso em um papel type: object required: – domainName – serviceName – uri properties: domainName: type: string description: Domínio do filtro serviceName: type: string description: Serviço do filtro uri: type: string description: Identificador único do filtro dentro do domínio/serviço name: type: string description: Nome label: type: string description: Campo label do filtro description: type: string description: Descrição sequence: type: integer format: int64 description: Sequência adminDefault: type: boolean description: Boolean indicando se o filtro é default para o admin do tenant resources: type: array items: type: object allOf: – #/definitions/resourceFilterScope description: Recursos que fazem parte do escopo deste filtro serviceFilter: description: Filtros de um serviço que serão vinculados ao papel type: object required: – domainName – serviceName – name – label – type – endpoint – sequence – parameters properties: domainName: type: string description: Domínio do filtro serviceName: type: string description: Serviço do filtro name: type: string description: Nome, campo identificador do filtro dentro do domínio/serviço label: type: string description: Campo label do filtro type: type: string description: Tipo do filtro endpoint: type: string description: Endpoint sequence: type: integer format: int64 description: Sequência parameters: type: array items: type: string minimum: 1 description: Parâmetros do filtro roleServiceFilterSet: description: Conjunto de chave do filtro e seus valores type: object required: – key – filters properties: key: type: object allOf: – #/definitions/roleServiceFilterKey description: Chave de domínio, serviço e sequencial filters: type: array items: type: object allOf: – #/definitions/roleServiceFilter minimum: 1 description: Campo obrigatório se for uma inclusão filterKeyRolesNamesMapping: description: Conjunto de chave de filtro e seus papéis. type: object required: – key – rolesNames properties: key: type: array items: type: object allOf: – #/definitions/roleServiceFilterKey minimum: 1 description: Chave de domínio, serviço e sequência. rolesNames: type: array items: type: string minimum: 1 description: Papéis vinculados à abrangência de filtro. roleProperty: description: Propriedade de um papel type: object required: – key – value properties: key: type: string maxLength: 255 description: A chave da propriedade value: type: string maxLength: 255 description: O valor da propriedade roleServiceFilterKey: description: Chave do filtro de serviço no papel type: object required: – domainName – serviceName – sequence properties: domainName: type: string description: Domínio do filtro serviceName: type: string description: Serviço do filtro sequence: type: integer format: int64 description: Sequência para agrupamento do conjunto de filtros roleServiceFilter: description: Chave e valor do filtro de serviço no papel type: object required: – name – value properties: name: type: string description: Identificador único do filtro dentro do domínio/serviço value: type: string maxLength: 255 description: Valor do filtro domainService: description: Conjunto de domínio e serviço type: object required: – domainName – serviceName properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço substitution: description: Uma substituição type: object required: – originalUser – from – to – substitutes properties: originalUser: type: string description: Username do usuário a ser substituído from: type: string format: date description: Data de início da substituição to: type: string format: date description: Data de término da substituição timezoneOffset: type: integer format: int64 description: Offset do timezone em minutos para tratar a data de início da substituição. Ex: -180 (GMT -03:00). Se não informado, será levado em consideração o timezone do servidor (0 – UTC). default: 0 reason: type: string maxLength: 1000 description: Razão pela qual a substituição está sendo feita substitutes: type: array items: type: object allOf: – #/definitions/substituteUser minimum: 1 description: Usuários a substituítem o usuário original substituteUser: description: Usuário substituto type: object required: – substituteUser properties: substituteUser: type: string description: Username do usuário substituto domain: type: string description: Dominio em que o usuário irá substituir o usuário original service: type: string description: Serviço em que o usuário irá substituir o usuário original role: type: string description: Papel no qual o usuário irá substituir o usuário original fullPermission: type: boolean description: Indica se o usuário substituto terá permissão total para os papeis do usuário substituído. Se essa propriedade for informada as propridades domain,service e role não devem ser informadas e vice-versa task: description: Um conjunto de recursos ações allOf: – #/definitions/basicTask – type: object required: – resources properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Os recursos associados a essa atividade. Só irão ser retornada as ações do recursos que estiverem associadas a atividade (mesmo que o recurso possua outras ações) g5Role: description: Informações básicas do papel, podendo informar o identificador da G5 e/ou nome do papel discriminator: _discriminator type: object required: – _discriminator properties: id: type: integer format: int64 description: Identificador G5 name: type: string description: Nome do papel _discriminator: type: string description: g5RoleCreated: description: Informa que o papel deverá ser criado, ignorando caso já esteja.\nNesse cenário o campo id e name são obrigatórios. allOf: – #/definitions/g5Role – type: object properties: description: type: string description: Descrição do papel g5RoleUpdated: description: Nesse caso o identificador G5 é obrigatório e caso o nome do papel seja diferente\ndo informado no campo name, o campo será atualizado se possível, pode ocorrer exceção\ncaso já possua um outro papel com o mesmo nome allOf: – #/definitions/g5Role – type: object properties: description: type: string description: Descrição do papel g5RoleDeleted: description: Informa que o papel deverá ser excluído allOf: – #/definitions/g5Role – type: object g5RoleAssigned: description: Usuário que será associado ao papel allOf: – #/definitions/g5Role – type: object required: – user properties: user: type: string description: Nome do usuário g5RoleUnassigned: description: Usuário que será desassociado do papel allOf: – #/definitions/g5Role – type: object required: – user properties: user: type: string description: Nome do usuário 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 basicTask: description: Informaçoes básicas de uma atividade discriminator: _discriminator type: object required: – uri – domain – service – name – master – _discriminator properties: uri: type: string maxLength: 255 description: O identificador único da atividade, seguindo o padrão: task://tenantDomain/domainName/serviceName/taskName domain: type: string description: Dominio associada a atividade service: type: string description: Serviço associado a atividade name: type: string description: Nome da atividade label: type: string description: Chave de internacionalização para o nome da atividade description: type: string description: Chave de internacionalização para a descrição da atividade master: type: boolean description: Informa se a task é master _discriminator: type: string description: delegation: description: Todos os dados de uma delegação type: object required: – delegationId – task – originUser – targetUser – from – to – includeFilters – createdDate – deletedDate – permissions – status properties: delegationId: type: string description: O identificador da delegação criada reason: type: string description: Descrição do motivo da delegação task: type: object allOf: – #/definitions/basicTask description: Informações da atividade originária dessa delegação originUser: type: string description: Usuário que realizou a delegação targetUser: type: string description: Usuário que receberá a delegação from: type: string format: date description: Data de início da delegação. Ela deve ser anterior ou igual a data de término e deve ser igual ou maior que a data atual. to: type: string format: date description: Data de término da delegação. Ela deve ser igual ou posterior a data de início. includeFilters: type: boolean description: Se a delegeção também inclui os filtros de serviço e recurso associados ao usuário de origem createdDate: type: string format: date-time description: Data de criação deletedDate: type: string format: date-time description: Data de exclusão permissions: type: array items: type: object allOf: – #/definitions/permission minimum: 1 description: As permissões da atividade que serão delegadas status: type: string allOf: – #/definitions/delegationStatus description: Status da delegação delegationChanged: description: As informações de alteração em uma delegação type: object required: – to properties: from: type: object allOf: – #/definitions/delegation description: Os dados da delegação antes da alteração to: type: object allOf: – #/definitions/delegation description: Os dados da delegação após a alteração lock: description: Registro para bloquear ou desbloquear recursos discriminator: _discriminator type: object required: – locked – _discriminator properties: locked: type: boolean description: Informar se irá bloquear ou desbloquear recursos _discriminator: type: string description: domainLock: description: Registro para bloquear ou desbloquear um domínio completo allOf: – #/definitions/lock – type: object required: – domain properties: domain: type: string description: Nome do domínio serviceLock: description: Registro para bloquear ou desbloquear um serviço específico allOf: – #/definitions/domainLock – type: object required: – service properties: service: type: string description: Nome do serviço permissionLock: description: Registro para bloquear ou desbloquear permissões específicas allOf: – #/definitions/lock – type: object required: – permissions properties: permissions: type: array items: type: object allOf: – #/definitions/permission minimum: 1 description: Conjunto de permissões (recurso e ação) taskLock: description: Registro para bloquear ou desbloquear todos recursos de uma atividade allOf: – #/definitions/lock – type: object required: – task properties: task: type: string description: URI da task permissionRoles: description: O nome dos papéis vinculados à permissão type: object required: – permission – roles properties: permission: type: object allOf: – #/definitions/permission description: Permissão roles: type: array items: type: string minimum: 1 description: Nome dos papéis userInfo: description: Informações do usuário type: object required: – id – username – blocked properties: id: type: string description: Identificador do Usuário username: type: string description: Nome do Usuário (username) blocked: type: boolean description: Indica se o usuário está bloqueado roleChanged: description: Alteração do nome do papel type: object required: – oldName – newName – newDescription properties: oldName: type: string description: Nome da role que foi alterada (nome atual) newName: type: string description: Novo nome da role newDescription: type: string description: Nova descrição do papel resourceSubstitution: description: Recursos e usuários substitutos type: object required: – permission – originalUser properties: permission: type: object allOf: – #/definitions/permission description: Conjunto de permissões (resource, ação) originalUser: type: array items: type: string minimum: 1 description: Lista de usuários substitutos resourceFilterScope: description: Recursos que fazem parte do escopo de um filtro de recurso type: object required: – resource – action properties: resource: type: string description: URI do recurso action: type: string description: Ação do recurso roleUser: description: Recursos que representam um usuário associado ou não à um papel type: object required: – name – fullName – email – assigned properties: name: type: string description: Nome/login do usuário fullName: type: string description: Nome completo do usuário email: type: string description: E-mail do usuário assigned: type: boolean description: Se o usuário está associado ao papel integration: description: Informações de integração de um papel type: object required: – id – type properties: id: type: string description: Identificador da integração type: type: string allOf: – #/definitions/integrationType description: Tipo da integração notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação