platform

Autorização Legada

20 views 31/07/2019 30/10/2019 integrador 0

2.0info: 2.1.0 Autorização Legada description: Responsável pela autorização legada na plataforma G7. x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: authorization_legacy contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /authorization_legacy/queries/listRolesWithUsers: post: description: Retorna uma lista com todos papéis e seus usuários tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: users: type: array items: type: string description: Nome de usuários utilizado como filtro responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/roleWithUsers minimum: 1 description: Listagem de papéis com seus usuários default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos papéis e seus usuários tags: – Queries x-senior-visibility: PUBLIC parameters: – name: users description: Nome de usuários utilizado como filtro in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/roleWithUsers minimum: 1 description: Listagem de papéis com seus usuários default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/getRolesById: post: description: Retorna todos papéis informados tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – rolesId properties: rolesId: type: array items: type: string minimum: 1 description: Identificadores dos papéis que devem ser retornados responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Listagem de papéis default: description: Error response schema: #/definitions/genericError get: description: Retorna todos papéis informados tags: – Queries x-senior-visibility: PUBLIC parameters: – name: rolesId description: Identificadores dos papéis que devem ser retornados in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Listagem de papéis default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaTodosPapeis: post: description: Retorna uma lista com todos os papéis, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Indica qual página deve ser exibida na grid com todos os papéis count: type: integer format: int64 description: Indica qual a quantidade de papéis é mostrada em cada página sort_by: type: string description: Nome do campo pelo qual os papéis são ordenados na grid sort_order: type: string description: Indica se a ordenação deve ser em ordem ASC ou DESC nome: type: string description: Nome utilizado como filtro responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: – #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: – #/definitions/papelRec minimum: 1 description: Contém as linhas com os papéis pagination: type: object allOf: – #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os papéis, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Indica qual página deve ser exibida na grid com todos os papéis in: query type: integer format: int64 – name: count description: Indica qual a quantidade de papéis é mostrada em cada página in: query type: integer format: int64 – name: sort_by description: Nome do campo pelo qual os papéis são ordenados na grid in: query type: string – name: sort_order description: Indica se a ordenação deve ser em ordem ASC ou DESC in: query type: string – name: nome description: Nome utilizado como filtro in: query type: string responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: – #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: – #/definitions/papelRec minimum: 1 description: Contém as linhas com os papéis pagination: type: object allOf: – #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaPapeisTenant: post: description: Retorna a lista de todos os papéis de um 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 a ter os papeis listados responses: 200: description: Ok schema: type: object required: – papeis properties: papeis: type: array items: type: object allOf: – #/definitions/papelRec minimum: 1 description: Listagem de papeis default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de todos os papéis de um tenant. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Nome do tenant a ter os papeis listados in: query required: true type: string responses: 200: description: Ok schema: type: object required: – papeis properties: papeis: type: array items: type: object allOf: – #/definitions/papelRec minimum: 1 description: Listagem de papeis default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/obtemPapel: post: description: Busca um papel através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do papel responses: 200: description: Ok schema: type: object required: – papel properties: papel: type: object allOf: – #/definitions/papelCompletoRec description: Informações sobre o papel default: description: Error response schema: #/definitions/genericError get: description: Busca um papel através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idPapel description: Identificador do papel in: query required: true type: string responses: 200: description: Ok schema: type: object required: – papel properties: papel: type: object allOf: – #/definitions/papelCompletoRec description: Informações sobre o papel default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaPermissoesUsuarioDetalhado: post: description: Retorna uma lista com todas permissões que um usuário possui, separadas por domínio, papel, serviço e recurso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario properties: idUsuario: type: string description: Identificador do usuário responses: 200: description: Ok schema: type: object required: – permissoes properties: permissoes: type: array items: type: object allOf: – #/definitions/dominioPermissaoRec minimum: 1 description: Lista com os domínios dos quais este usuário possui alguma permissão de acesso default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todas permissões que um usuário possui, separadas por domínio, papel, serviço e recurso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idUsuario description: Identificador do usuário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – permissoes properties: permissoes: type: array items: type: object allOf: – #/definitions/dominioPermissaoRec minimum: 1 description: Lista com os domínios dos quais este usuário possui alguma permissão de acesso default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/obtemPapelBasico: post: description: Busca um papel através do seu identificador (Somente informações do papel, sem domínios, permissões e etc) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do papel responses: 200: description: Ok schema: type: object required: – papel properties: papel: type: object allOf: – #/definitions/papelBasicoRec description: Informações sobre o papel default: description: Error response schema: #/definitions/genericError get: description: Busca um papel através do seu identificador (Somente informações do papel, sem domínios, permissões e etc) tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idPapel description: Identificador do papel in: query required: true type: string responses: 200: description: Ok schema: type: object required: – papel properties: papel: type: object allOf: – #/definitions/papelBasicoRec description: Informações sobre o papel default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaPapeisUsuario: post: description: Lista os papéis de um usuário tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario properties: idUsuario: type: string description: Identificador do Usuário responses: 200: description: Ok schema: type: object required: – papeis properties: papeis: type: array items: type: object allOf: – #/definitions/recPapel minimum: 1 description: Lista com os ids dos papéis associados ao usuário default: description: Error response schema: #/definitions/genericError get: description: Lista os papéis de um usuário tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idUsuario description: Identificador do Usuário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – papeis properties: papeis: type: array items: type: object allOf: – #/definitions/recPapel minimum: 1 description: Lista com os ids dos papéis associados ao usuário default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaPapeisUsuarioWeb: post: description: Retorna uma lista com os papéis que o usuário possui tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario properties: idUsuario: type: string description: Identificador do usuário responses: 200: description: Ok schema: type: object properties: papeis: type: array items: type: object allOf: – #/definitions/papelRec description: Lista com os papéis associados ao usuário default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com os papéis que o usuário possui tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idUsuario description: Identificador do usuário in: query required: true type: string responses: 200: description: Ok schema: type: object properties: papeis: type: array items: type: object allOf: – #/definitions/papelRec description: Lista com os papéis associados ao usuário default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listPapel: post: description: Primitiva para listar os papéis da entidade tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/pageRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/pagedResults default: description: Error response schema: #/definitions/genericError get: description: Primitiva para listar os papéis da entidade tags: – Queries x-senior-visibility: PUBLIC parameters: – name: offset description: in: query required: true type: integer format: int64 – name: size description: in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/pagedResults default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/retrievePapel: post: description: Primitiva para buscar a entidade do papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/id responses: 200: description: Ok schema: type: object allOf: – #/definitions/Papel default: description: Error response schema: #/definitions/genericError get: description: Primitiva para buscar a entidade do papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/Papel default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/createPapel: post: description: Primitiva para criar a entidade do papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/Papel responses: 200: description: Ok schema: type: object allOf: – #/definitions/Papel default: description: Error response schema: #/definitions/genericError get: description: Primitiva para criar a entidade do papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idPapel description: Identificador do Papel in: query required: true type: string – name: nome description: Nome do Papel in: query required: true type: string – name: descricao description: Descrição do Papel in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/Papel default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/updatePapel: post: description: Primitiva para atualizar a entidade do papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/Papel responses: 200: description: Ok schema: type: object allOf: – #/definitions/Papel default: description: Error response schema: #/definitions/genericError get: description: Primitiva para atualizar a entidade do papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idPapel description: Identificador do Papel in: query required: true type: string – name: nome description: Nome do Papel in: query required: true type: string – name: descricao description: Descrição do Papel in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/Papel default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/deletePapel: post: description: Primitiva para deletar a entidade do papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/id responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Primitiva para deletar a entidade do papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/obtemPapeisUsuario: post: description: Lista os papeis do usuário que executou a primitiva (a partir do username do cabeçalho da mensagem) tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – papeis properties: papeis: type: array items: type: object allOf: – #/definitions/recPapel minimum: 1 description: Lista com os papéis associados ao usuário default: description: Error response schema: #/definitions/genericError get: description: Lista os papeis do usuário que executou a primitiva (a partir do username do cabeçalho da mensagem) tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – papeis properties: papeis: type: array items: type: object allOf: – #/definitions/recPapel minimum: 1 description: Lista com os papéis associados ao usuário default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaUsuariosCompletosPapel: post: description: Lista os informações completas dos usuários que possuem um determinado papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do Papel responses: 200: description: Ok schema: type: object required: – usuarios properties: usuarios: type: array items: type: object allOf: – #/definitions/Usuario minimum: 1 description: Lista com os usuarios que possuem o papel default: description: Error response schema: #/definitions/genericError get: description: Lista os informações completas dos usuários que possuem um determinado papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idPapel description: Identificador do Papel in: query required: true type: string responses: 200: description: Ok schema: type: object required: – usuarios properties: usuarios: type: array items: type: object allOf: – #/definitions/Usuario minimum: 1 description: Lista com os usuarios que possuem o papel default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaPapeisAcao: post: description: Lista os papéis que podem executar uma determinada ação tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idAcao properties: idAcao: type: string description: Identificador da ação responses: 200: description: Ok schema: type: object required: – papeis properties: papeis: type: array items: type: object allOf: – #/definitions/recPapel minimum: 1 description: Lista com os ids dos papéis que podem executar a ação default: description: Error response schema: #/definitions/genericError get: description: Lista os papéis que podem executar uma determinada ação tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idAcao description: Identificador da ação in: query required: true type: string responses: 200: description: Ok schema: type: object required: – papeis properties: papeis: type: array items: type: object allOf: – #/definitions/recPapel minimum: 1 description: Lista com os ids dos papéis que podem executar a ação default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaAcoesPapel: post: description: Lista as ações atribuídas a um papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do Papel responses: 200: description: Ok schema: type: object required: – acoes properties: acoes: type: array items: type: object allOf: – #/definitions/recAcao minimum: 1 description: Lista com os ids das ações atribuídas ao papel default: description: Error response schema: #/definitions/genericError get: description: Lista as ações atribuídas a um papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idPapel description: Identificador do Papel in: query required: true type: string responses: 200: description: Ok schema: type: object required: – acoes properties: acoes: type: array items: type: object allOf: – #/definitions/recAcao minimum: 1 description: Lista com os ids das ações atribuídas ao papel default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaUsuariosPapel: post: description: Lista os usuários que possuem um determinado papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do Papel responses: 200: description: Ok schema: type: object required: – usuarios properties: usuarios: type: array items: type: string minimum: 1 description: Lista com os ids dos usuários que possuem o papel default: description: Error response schema: #/definitions/genericError get: description: Lista os usuários que possuem um determinado papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idPapel description: Identificador do Papel in: query required: true type: string responses: 200: description: Ok schema: type: object required: – usuarios properties: usuarios: type: array items: type: string minimum: 1 description: Lista com os ids dos usuários que possuem o papel default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaServicosEQuantidadeAcoes: post: description: Retorna uma lista de serviços com base em um domínio, número total de ações e o número de ações permitidas dentro do serviço para o papel quando informado. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idDominio properties: page: type: integer format: int64 description: Indica qual página deve ser retornada default: 1 count: type: integer format: int64 description: Indica qual a quantidade de recursos é mostrada em cada página default: 10 idPapel: type: string description: Identificador do papel idDominio: type: string description: Identificador do domínio responses: 200: description: Ok schema: type: object required: – servicos – pagination properties: servicos: type: array items: type: object allOf: – #/definitions/servicoDominioAcoesPapelRec minimum: 1 description: pagination: type: object allOf: – #/definitions/paginationRec description: Contém os dados para a paginação da grid default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de serviços com base em um domínio, número total de ações e o número de ações permitidas dentro do serviço para o papel quando informado. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Indica qual página deve ser retornada in: query type: integer format: int64 – name: count description: Indica qual a quantidade de recursos é mostrada em cada página in: query type: integer format: int64 – name: idPapel description: Identificador do papel in: query type: string – name: idDominio description: Identificador do domínio in: query required: true type: string responses: 200: description: Ok schema: type: object required: – servicos – pagination properties: servicos: type: array items: type: object allOf: – #/definitions/servicoDominioAcoesPapelRec minimum: 1 description: pagination: type: object allOf: – #/definitions/paginationRec description: Contém os dados para a paginação da grid default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaDetalhesDominios: post: description: Retorna uma lista com todos os serviços dos domínios passados como parâmetro. Retorna não apenas os serviços, mas também os recursos, ações, filtros customizados, etc.. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – dominios properties: dominios: type: array items: type: string minimum: 1 description: Lista com os identificadores dos domínios responses: 200: description: Ok schema: type: object required: – dominios properties: dominios: type: array items: type: object allOf: – #/definitions/dominioPermissaoPapelRec minimum: 1 description: Lista com os domínios e respectivos detalhes default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os serviços dos domínios passados como parâmetro. Retorna não apenas os serviços, mas também os recursos, ações, filtros customizados, etc.. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: dominios description: Lista com os identificadores dos domínios in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – dominios properties: dominios: type: array items: type: object allOf: – #/definitions/dominioPermissaoPapelRec minimum: 1 description: Lista com os domínios e respectivos detalhes default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaDominios: post: description: Lista os domínios existentes tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dominios properties: dominios: type: array items: type: object allOf: – #/definitions/recDominio minimum: 1 description: Lista com os domínios cadastrados default: description: Error response schema: #/definitions/genericError get: description: Lista os domínios existentes tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dominios properties: dominios: type: array items: type: object allOf: – #/definitions/recDominio minimum: 1 description: Lista com os domínios cadastrados default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaServicosDominio: post: description: Retorna uma lista com todos os serviços que o domínio passado como parâmetro possui. Retorna não apenas os serviços, mas todos os seus recursos.Se for passado um papel, retorna quais recursos o mesmo possui acesso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idDominio properties: idDominio: type: string description: Identificador do domínio idPapel: type: string description: Identificador do papel responses: 200: description: Ok schema: type: object properties: servicos: type: array items: type: object allOf: – #/definitions/servicoRec description: Lista com os serviços que este domínio possui default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os serviços que o domínio passado como parâmetro possui. Retorna não apenas os serviços, mas todos os seus recursos.Se for passado um papel, retorna quais recursos o mesmo possui acesso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idDominio description: Identificador do domínio in: query required: true type: string – name: idPapel description: Identificador do papel in: query type: string responses: 200: description: Ok schema: type: object properties: servicos: type: array items: type: object allOf: – #/definitions/servicoRec description: Lista com os serviços que este domínio possui default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaServicosPermitidos: post: description: Retorna uma lista com os serviços que um papel tem permissão de acessar, dentro de um domínio tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel – idDominio properties: idPapel: type: string description: Identificador do papel idDominio: type: string description: Identificador do domínio responses: 200: description: Ok schema: type: object properties: servicos: type: array items: type: object allOf: – #/definitions/servicoPermissaoPapelRec description: Lista com os serviços que o papel pode acessar, dentro do domínio default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com os serviços que um papel tem permissão de acessar, dentro de um domínio tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idPapel description: Identificador do papel in: query required: true type: string – name: idDominio description: Identificador do domínio in: query required: true type: string responses: 200: description: Ok schema: type: object properties: servicos: type: array items: type: object allOf: – #/definitions/servicoPermissaoPapelRec description: Lista com os serviços que o papel pode acessar, dentro do domínio default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaDominiosPermitidos: post: description: Retorna uma lista com os domínios que um papel tem permissão para acessar. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do papel responses: 200: description: Ok schema: type: object properties: dominios: type: array items: type: object allOf: – #/definitions/dominioRec description: Lista com os domínios nos quais existe ao menos uma ação permitida para o papel default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com os domínios que um papel tem permissão para acessar. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idPapel description: Identificador do papel in: query required: true type: string responses: 200: description: Ok schema: type: object properties: dominios: type: array items: type: object allOf: – #/definitions/dominioRec description: Lista com os domínios nos quais existe ao menos uma ação permitida para o papel default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaTodosDominiosEQuantidadeAcoes: post: description: Retorna uma lista com todos os domínios, número total de ações e o número de ações permitidas dentro do domínio para o papel quando informado. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Indica qual página deve ser retornada default: 1 count: type: integer format: int64 description: Indica qual a quantidade de recursos é mostrada em cada página default: 10 idPapel: type: string description: Identificador do papel responses: 200: description: Ok schema: type: object required: – pagination properties: dominios: type: array items: type: object allOf: – #/definitions/dominioAcoesPapelRec description: Resultado pagination: type: object allOf: – #/definitions/paginationRec description: Contém os dados para a paginação da grid default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os domínios, número total de ações e o número de ações permitidas dentro do domínio para o papel quando informado. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Indica qual página deve ser retornada in: query type: integer format: int64 – name: count description: Indica qual a quantidade de recursos é mostrada em cada página in: query type: integer format: int64 – name: idPapel description: Identificador do papel in: query type: string responses: 200: description: Ok schema: type: object required: – pagination properties: dominios: type: array items: type: object allOf: – #/definitions/dominioAcoesPapelRec description: Resultado pagination: type: object allOf: – #/definitions/paginationRec description: Contém os dados para a paginação da grid default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaRecursosAcoes: post: description: Obtém uma lista com todos os recursos e suas respectivas ações tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – recursosAcoes properties: recursosAcoes: type: array items: type: object allOf: – #/definitions/recAcoesRecurso minimum: 1 description: Lista com os recursos e suas ações default: description: Error response schema: #/definitions/genericError get: description: Obtém uma lista com todos os recursos e suas respectivas ações tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – recursosAcoes properties: recursosAcoes: type: array items: type: object allOf: – #/definitions/recAcoesRecurso minimum: 1 description: Lista com os recursos e suas ações default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/obtemRecurso: post: description: Busca um recurso através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idRecurso properties: idRecurso: type: string description: Identificador do recurso responses: 200: description: Ok schema: type: object required: – recurso properties: recurso: type: object allOf: – #/definitions/recursoCompletoRec description: Informações sobre o recurso default: description: Error response schema: #/definitions/genericError get: description: Busca um recurso através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idRecurso description: Identificador do recurso in: query required: true type: string responses: 200: description: Ok schema: type: object required: – recurso properties: recurso: type: object allOf: – #/definitions/recursoCompletoRec description: Informações sobre o recurso default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/obtemPropriedadesPapel: post: description: Retorna a lista de propriedades de um Papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do papel responses: 200: description: Ok schema: type: object required: – propriedades properties: propriedades: type: array items: type: object allOf: – #/definitions/recPropriedade minimum: 1 description: Lista com as propriedades default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de propriedades de um Papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idPapel description: Identificador do papel in: query required: true type: string responses: 200: description: Ok schema: type: object required: – propriedades properties: propriedades: type: array items: type: object allOf: – #/definitions/recPropriedade minimum: 1 description: Lista com as propriedades default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaUsuariosRecurso: post: description: Lista os usuários que possuem permissão paro o recurso e ações passadas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – uriRecurso – acao properties: uriRecurso: type: string description: URI do recurso acao: type: string description: Ação para o recurso responses: 200: description: Ok schema: type: object required: – usuarios properties: usuarios: type: array items: type: object allOf: – #/definitions/Usuario minimum: 1 description: Lista com os usuários que tem acesso ao recurso default: description: Error response schema: #/definitions/genericError get: description: Lista os usuários que possuem permissão paro o recurso e ações passadas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: uriRecurso description: URI do recurso in: query required: true type: string – name: acao description: Ação para o recurso in: query required: true type: string responses: 200: description: Ok schema: type: object required: – usuarios properties: usuarios: type: array items: type: object allOf: – #/definitions/Usuario minimum: 1 description: Lista com os usuários que tem acesso ao recurso default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/obtemRecursoAcoes: post: description: Retorna um recurso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – uriRecurso properties: uriRecurso: type: string description: URI do recurso responses: 200: description: Ok schema: type: object properties: recurso: type: object allOf: – #/definitions/RecursoPermissao description: Recurso default: description: Error response schema: #/definitions/genericError get: description: Retorna um recurso tags: – Queries x-senior-visibility: PUBLIC parameters: – name: uriRecurso description: URI do recurso in: query required: true type: string responses: 200: description: Ok schema: type: object properties: recurso: type: object allOf: – #/definitions/RecursoPermissao description: Recurso default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaTodosRecursos: post: description: Retorna uma lista com todos os recursos, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Indica qual página deve ser exibida na grid com todos os recursos count: type: integer format: int64 description: Indica qual a quantidade de recursos é mostrada em cada página sort_by: type: string description: Nome do campo pelo qual os recursos são ordenados na grid sort_order: type: string description: Indica se a ordenação deve ser em ordem ASC ou DESC nome: type: string description: Nome utilizado como filtro responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: – #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: – #/definitions/recursoRec minimum: 1 description: Contém as linhas com os recursos pagination: type: object allOf: – #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os recursos, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Indica qual página deve ser exibida na grid com todos os recursos in: query type: integer format: int64 – name: count description: Indica qual a quantidade de recursos é mostrada em cada página in: query type: integer format: int64 – name: sort_by description: Nome do campo pelo qual os recursos são ordenados na grid in: query type: string – name: sort_order description: Indica se a ordenação deve ser em ordem ASC ou DESC in: query type: string – name: nome description: Nome utilizado como filtro in: query type: string responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: – #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: – #/definitions/recursoRec minimum: 1 description: Contém as linhas com os recursos pagination: type: object allOf: – #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/verificaPermissaoFiltros: post: description: Verifica se o usuário tem permissão de acesso a um recurso e, se tiver, retorna os filtros que estão associados a este recurso/ação. Se não possuir permissão, os filtros vem com nulo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeUsuario – uriRecurso – nomeAcao – atributos properties: nomeUsuario: type: string description: Nome do usuário uriRecurso: type: string description: URI do recurso nomeAcao: type: string description: Nome ação atributos: type: array items: type: object allOf: – #/definitions/recAtributo minimum: 1 description: Atributos responses: 200: description: Ok schema: type: object required: – permitido – filtrosCustomizados – filtros properties: permitido: type: boolean description: Indica se pode ou não acessar o recurso passado como parâmetro filtrosCustomizados: type: array items: type: string minimum: 1 description: lista com as URIS dos filtros customizados que estão ativos para este usuário filtros: type: array items: type: string minimum: 1 description: lista com expressões json contendo os filtros de dados ativos para este usuário default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaRecursosServico: post: description: Retorna uma lista com todos os recursos de um determinado serviço tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idServico properties: idServico: type: string description: Identificador (GUID) do serviço responses: 200: description: Ok schema: type: object properties: recursos: type: array items: type: object allOf: – #/definitions/recursoRec description: Lista com os recursos pertencentes ao serviço default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os recursos de um determinado serviço tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idServico description: Identificador (GUID) do serviço in: query required: true type: string responses: 200: description: Ok schema: type: object properties: recursos: type: array items: type: object allOf: – #/definitions/recursoRec description: Lista com os recursos pertencentes ao serviço default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/verificaPermissoesFiltros: post: description: Verifica se o usuário tem permissão de acesso a um recurso e, se tiver, retorna os filtros que estão associados a este recurso/ação. Se não possuir permissão, os filtros vem com nulo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeUsuario – items properties: nomeUsuario: type: string description: Nome do usuário items: type: array items: type: object allOf: – #/definitions/recItemPermissao minimum: 1 description: lista com os itens que serão validados responses: 200: description: Ok schema: type: object required: – permissoes properties: permissoes: type: array items: type: object allOf: – #/definitions/recPermissaoFiltros minimum: 1 description: Lista com as permissões de acesso e filtros, para cada recurso passado como parâmetro default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaRecursosServicoPapel: post: description: Retorna uma lista com todos os recursos de um determinado serviço com base no papel informado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idServico properties: idServico: type: string description: Identificador (GUID) do serviço idPapel: type: string description: Identificador do papel responses: 200: description: Ok schema: type: object required: – recursos properties: recursos: type: array items: type: object allOf: – #/definitions/recursoPermissaoPapelRec minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os recursos de um determinado serviço com base no papel informado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idServico description: Identificador (GUID) do serviço in: query required: true type: string – name: idPapel description: Identificador do papel in: query type: string responses: 200: description: Ok schema: type: object required: – recursos properties: recursos: type: array items: type: object allOf: – #/definitions/recursoPermissaoPapelRec minimum: 1 description: default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/obtemFiltrosPorPapel: post: description: Obtem os filtros associados a um papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do papel responses: 200: description: Ok schema: type: object required: – filtros properties: filtros: type: array items: type: object allOf: – #/definitions/filtrosRecursosRec minimum: 1 description: Lista com os filtros que o papel possui default: description: Error response schema: #/definitions/genericError get: description: Obtem os filtros associados a um papel tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idPapel description: Identificador do papel in: query required: true type: string responses: 200: description: Ok schema: type: object required: – filtros properties: filtros: type: array items: type: object allOf: – #/definitions/filtrosRecursosRec minimum: 1 description: Lista com os filtros que o papel possui default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaFiltrosDominioPapel: post: description: Retorna uma lista com os filtros que o papel possui, no domínio selecionado. Caso o papel seja nulo, traz apenas os campos do filtro, sem valores. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idDominio properties: idDominio: type: string description: Identificador do domínio idPapel: type: string description: Identificador do papel responses: 200: description: Ok schema: type: object required: – filtros properties: filtros: type: array items: type: object allOf: – #/definitions/servicoFiltroRec minimum: 1 description: lista com os filtros default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com os filtros que o papel possui, no domínio selecionado. Caso o papel seja nulo, traz apenas os campos do filtro, sem valores. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idDominio description: Identificador do domínio in: query required: true type: string – name: idPapel description: Identificador do papel in: query type: string responses: 200: description: Ok schema: type: object required: – filtros properties: filtros: type: array items: type: object allOf: – #/definitions/servicoFiltroRec minimum: 1 description: lista com os filtros default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/getServicesWithFilters: post: description: Lista os serviços que possuem exatamente os mesmos campos de filtro informados no parâmetro. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fields properties: fields: type: array items: type: object allOf: – #/definitions/filterField minimum: 1 description: Lista com os campos que os serviços devem possuir para serem retornados responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/serviceDomain minimum: 1 description: Lista com os serviços que possuem os mesmos campos de filtro que foram informados. default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/obtemFiltrosAcessoDados: post: description: Obtém uma lista com os filtros de acesso aos dados que um determinado usuário possui tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeUsuario – uriRecurso – nomeAcao properties: nomeUsuario: type: string description: Nome do usuário uriRecurso: type: string description: URI do recurso nomeAcao: type: string description: Nome ação responses: 200: description: Ok schema: type: object required: – filtrosCustomizados – filtros properties: filtrosCustomizados: type: array items: type: string minimum: 1 description: lista com as URIS dos filtros customizados que estão ativos para este usuário filtros: type: array items: type: string minimum: 1 description: lista com expressões json contendo os filtros de dados ativos para este usuário default: description: Error response schema: #/definitions/genericError get: description: Obtém uma lista com os filtros de acesso aos dados que um determinado usuário possui tags: – Queries x-senior-visibility: PUBLIC parameters: – name: nomeUsuario description: Nome do usuário in: query required: true type: string – name: uriRecurso description: URI do recurso in: query required: true type: string – name: nomeAcao description: Nome ação in: query required: true type: string responses: 200: description: Ok schema: type: object required: – filtrosCustomizados – filtros properties: filtrosCustomizados: type: array items: type: string minimum: 1 description: lista com as URIS dos filtros customizados que estão ativos para este usuário filtros: type: array items: type: string minimum: 1 description: lista com expressões json contendo os filtros de dados ativos para este usuário default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaRecursosComFiltro: post: description: Retorna uma lista com todos os domínios e serviços que contenham algum recurso cujo nome esteja no filtro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: nome: type: string description: Nome ou parte do nome do recurso que será utilizado como filtro. No mínimo deverão ser informados 3 caracteres do nome. idPapel: type: string description: Identificador do papel responses: 200: description: Ok schema: type: object properties: dominios: type: array items: type: object allOf: – #/definitions/dominioRec description: Lista com os domínios, serviços e recursos default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os domínios e serviços que contenham algum recurso cujo nome esteja no filtro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: nome description: Nome ou parte do nome do recurso que será utilizado como filtro. No mínimo deverão ser informados 3 caracteres do nome. in: query type: string – name: idPapel description: Identificador do papel in: query type: string responses: 200: description: Ok schema: type: object properties: dominios: type: array items: type: object allOf: – #/definitions/dominioRec description: Lista com os domínios, serviços e recursos default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/listaDominiosTenant: post: description: Retorna uma lista com todos os domínios existentes para um determinado tenant. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: idTenant: type: string description: Identificar do tenant. Se não for informado, será utilizado o tenant obtido a partir do cabeçalho da mensagem responses: 200: description: Ok schema: type: object required: – dominios properties: dominios: type: array items: type: object allOf: – #/definitions/dominioRec minimum: 1 description: Lista com os domínios deste tenant. A lista vai apenas com os domínios, sem os serviços subordinados a eles default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os domínios existentes para um determinado tenant. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idTenant description: Identificar do tenant. Se não for informado, será utilizado o tenant obtido a partir do cabeçalho da mensagem in: query type: string responses: 200: description: Ok schema: type: object required: – dominios properties: dominios: type: array items: type: object allOf: – #/definitions/dominioRec minimum: 1 description: Lista com os domínios deste tenant. A lista vai apenas com os domínios, sem os serviços subordinados a eles default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /authorization_legacy/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/inserePapel: post: description: Insere um novo papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomePapel properties: nomePapel: type: string description: Nome do papel descricaoPapel: type: string description: Descrição do papel (opcional) usuarios: type: array items: type: object allOf: – #/definitions/usuarioPapelRec description: Lista com os usuários associados a este papel permissoes: type: array items: type: object allOf: – #/definitions/dominioPermissaoPapelRec description: Lista com as permissões que este papel possui filtros: type: array items: type: object allOf: – #/definitions/dominioFiltroPapelRec description: Lista com os filtros que este papel possui propriedades: type: array items: type: object allOf: – #/definitions/propriedadeRec description: Lista com as propriedades deste papel (opcional) responses: 200: description: Ok schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do papel recém adicionado default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/inserePapelTenant: post: description: Insere um novo papel em um determinado tenant. Só pode ser executado pelo usuário admin do tenant master. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nomeTenant – nomePapel – descricaoPapel – usuarios – permissoes – filtros properties: nomeTenant: type: string description: Nome do tenant nomePapel: type: string description: Nome do papel descricaoPapel: type: string description: Descrição do papel (opcional) usuarios: type: array items: type: object allOf: – #/definitions/usuarioPapelRec minimum: 1 description: Lista com os usuários associados a este papel permissoes: type: array items: type: object allOf: – #/definitions/dominioPermissaoPapelRec minimum: 1 description: Lista com as permissões que este papel possui filtros: type: array items: type: object allOf: – #/definitions/dominioFiltroPapelRec minimum: 1 description: Lista com os filtros que este papel possui propriedades: type: array items: type: object allOf: – #/definitions/propriedadeRec description: Lista com as propriedades deste papel (opcional) responses: 200: description: Ok schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do papel recém adicionado default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/removePapelUsuario: post: description: Remove o papel de um usuário. Um usuário deve ter ao menos um papel atribuído. Caso seja feita uma tentativa de excluir todos os papéis, uma exceção será lançada. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario – idPapel properties: idUsuario: type: string description: Identificador do Usuário idPapel: type: string description: Identificador do Papel responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um boolean com TRUE, apenas para o API Manager não gerar erro default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/adicionaPapelUsuario: post: description: Adiciona um papel a um usuário tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario – idPapel properties: idUsuario: type: string description: Identificador do Usuário idPapel: type: string description: Identificador do Papel responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um boolean com TRUE, apenas para o API Manager não gerar erro default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/removeRecursoAcoesPorId: post: description: Remove um recurso e suas respectivas ações tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idRecurso properties: idRecurso: type: string description: Identificador do recurso responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Status da operação default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/atualizaPapel: post: description: Atualiza um papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel – nomePapel properties: idPapel: type: string description: Identificador do papel nomePapel: type: string description: Nome do papel descricaoPapel: type: string description: Descrição do papel usuarios: type: array items: type: object allOf: – #/definitions/usuarioPapelRec description: Lista com os usuários associados a este papel permissoes: type: array items: type: object allOf: – #/definitions/dominioPermissaoPapelRec description: Lista com as permissões que este papel possui filtros: type: array items: type: object allOf: – #/definitions/dominioFiltroPapelRec description: Lista com os filtros que este papel possui propriedades: type: array items: type: object allOf: – #/definitions/propriedadeRec description: Lista com as propriedades deste papel (opcional) responses: 200: description: Ok schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do papel recém alterado default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/duplicaPapel: post: description: Duplica um papel já existente tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapelOrigem – nomePapel properties: idPapelOrigem: type: string description: Identificador do papel origem nomePapel: type: string description: Nome do novo papel descricaoPapel: type: string description: Descrição do novo papel responses: 200: description: Ok schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do papel recém-criado default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/adicionaPropriedadePapel: post: description: Adiciona uma propriedade em um Papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel – nome – valor properties: idPapel: type: string description: Identificador do Papel nome: type: string description: Nome da propriedade valor: type: string description: Valor da propriedade responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um boolean com TRUE, apenas para o API Manager não gerar erro default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/atualizaRecurso: post: description: Atualiza um recurso. Apenas as suas propriedades podem ser alteradas tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idRecurso properties: idRecurso: type: string description: Identificador do recurso propriedades: type: array items: type: object allOf: – #/definitions/propriedadeRec description: Lista com as propriedades do recurso responses: 200: description: Ok schema: type: object required: – idRecurso properties: idRecurso: type: string description: Identificador do recurso recém alterado default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/atualizaPropriedadePapel: post: description: Atualiza uma propriedade de um Papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel – idPropriedade – nome – valor properties: idPapel: type: string description: Identificador do Papel idPropriedade: type: string description: Identificador da propriedade nome: type: string description: Nome da propriedade valor: type: string description: Valor da propriedade responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um boolean com TRUE, apenas para o API Manager não gerar erro default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/removePropriedadePapel: post: description: Remove uma propriedade de um Papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel – idPropriedade properties: idPapel: type: string description: Identificador do Papel idPropriedade: type: string description: identificador da Propriedade que será excluída responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um boolean com TRUE, apenas para o API Manager não gerar erro default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/removeAcaoDoPapel: post: description: Revoga a permissão de uma ação para um Papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel – idAcaoPermissao properties: idPapel: type: string description: Identificador do Papel idAcaoPermissao: type: string description: Identificador da ação responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um boolean com TRUE, apenas para o API Manager não gerar erro default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/verificaPermissao: post: description: Verifica se o usuário tem permissão para executar uma determinada ação em um recurso tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – uriRecurso – nomeAcao properties: nomeUsuario: type: string description: Nome do usuário. Se não for informado será utilizado o usuário da mensagem. uriRecurso: type: string description: URI do recurso nomeAcao: type: string description: Nome ação responses: 200: description: Ok schema: type: object required: – permitido properties: permitido: type: boolean description: True se o usuário pode executar a ação ou false se não pode default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/verificaPermissoesRecursos: post: description: Verifica permissões em várias ações para vários recursos tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – recursos properties: nomeUsuario: type: string description: Nome do usuário. Se não for informado será utilizado o usuário da mensagem. recursos: type: array items: type: object allOf: – #/definitions/recRecurso minimum: 1 description: Lista dos recursos para verificação de permissão responses: 200: description: Ok schema: type: object required: – permissoes properties: permissoes: type: array items: type: object allOf: – #/definitions/recRecursoPermissao minimum: 1 description: Lista de permissões para cada recurso e ações default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/verificaPermissaoAtributos: post: description: Verifica se o usuário tem permissão de executar uma determinada ação em um recurso e seus atributos tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeUsuario – uriRecurso – nomeAcao – atributos properties: nomeUsuario: type: string description: Nome do usuário uriRecurso: type: string description: URI do recurso nomeAcao: type: string description: Nome ação atributos: type: array items: type: object allOf: – #/definitions/recAtributo minimum: 1 description: Atributos responses: 200: description: Ok schema: type: object required: – permitido properties: permitido: type: boolean description: True se o usuário pode executar a ação ou false se não pode default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/verificaPermissoes: post: description: Verifica se o usuário tem permissão para executar uma determinada ação em uma lista de recursos. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeAcao – recursos properties: nomeUsuario: type: string description: Nome do usuário. Se não for informado será utilizado o usuário da mensagem. nomeAcao: type: string description: Nome da ação que será verificada recursos: type: array items: type: string minimum: 1 description: Lista com as URIs dos recursos que serão validados responses: 200: description: Ok schema: type: object required: – permissoes properties: permissoes: type: array items: type: object allOf: – #/definitions/recPermissao minimum: 1 description: Lista com as permissões relativas aos itens passados como parâmetro. É uma lista contendo o nome de cada recurso e um boolean, indicando se o recurso é permitido ou não default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/atualizaFiltros: post: description: Insere ou atualiza todos os filtros associados a um papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel properties: idPapel: type: string description: Identificador do papel acoes: type: array items: type: object allOf: – #/definitions/acaoFiltroSimplesRec description: Lista com as ações e respectivos filtros responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: retorna um boolean, apenas para o API Manager não gerar erro default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/atribuiAcaoAoPapel: post: description: Permite a execução de uma ação por um papel tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idPapel – idAcaoPermissao properties: idPapel: type: string description: Identificador do papel idAcaoPermissao: type: string description: Identificador da ação responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um boolean com TRUE, apenas para o API Manager não gerar erro default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/removeRecursoAcoes: post: description: Remove um recurso e suas respectivas ações tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – uriRecurso properties: uriRecurso: type: string description: URI do recurso responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Status da operação default: description: Error response schema: #/definitions/genericError /authorization_legacy/actions/insereRecursoAcoes: post: description: Insere um recurso e suas respectivas ações tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeDominio – nomeServico – nomeRecurso – descricaoRecurso – URIRecurso – listaAcoes properties: nomeDominio: type: string description: Nome do domínio do recurso nomeServico: type: string description: Nome do serviço do recurso nomeRecurso: type: string description: Nome do recurso rotuloRecurso: type: string description: Rótulo do recurso descricaoRecurso: type: string description: Descrição do recurso URIRecurso: type: string description: URI do recurso master: type: boolean description: Indica se o recurso é master listaAcoes: type: array items: type: string minimum: 1 description: Lista com as ações que este recurso possui. Por exemplo: Visualizar, Executar, etc.. responses: 200: description: Ok schema: type: object required: – idRecurso properties: idRecurso: type: string description: O identificador do recurso recém criado default: description: Error response schema: #/definitions/genericError /authorization_legacy/signals/replicateFilterValues: post: description: Replica os valores de campos de filtro (abrangência) de um papel e serviço para outros serviços.\n Caso existam outros valores configurados anteriormente nos serviços de destino esses valores serão\n apagados, ao final do processo todos os serviços de destino vão possuir exatamente os mesmos valores\n do serviço de origem para o papel informado. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – roleId – originServiceId – destinationServices properties: roleId: type: string description: Id do papel que possui os valores que devem ser replicadas para outros serviços. originServiceId: type: string description: Id do serviço que possui os valores que devem ser replicados para outros serviços. destinationServices: type: array items: type: string minimum: 1 description: Id dos serviços que devem ficar com os valores de campos de filtro (abrangência) iguais ao serviço e papel de origem. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError definitions: 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 dominioRec: description: Representa um domínio type: object required: – idDominio – nomeDominio – rotuloDominio properties: idDominio: type: string description: Identificador do domínio nomeDominio: type: string description: Nome do domínio rotuloDominio: type: string description: Rótulo do domínio descricaoDominio: type: string description: Descrição do domínio (opcional) servicos: type: array items: type: object allOf: – #/definitions/servicoRec description: Lista com os servicos que este domínio possui servicoRec: description: Representa um servico type: object required: – idServico – nomeServico – rotuloServico properties: idServico: type: string description: Identificador do servico nomeServico: type: string description: Nome do servico rotuloServico: type: string description: Rótulo do servico descricaoServico: type: string description: Descrição do serviço (opcional) recursos: type: array items: type: object allOf: – #/definitions/recursoAcoesRec description: Lista com os recursos que ele possui recursoRec: description: Representa um recurso type: object required: – idRecurso – nomeRecurso – rotuloRecurso properties: idRecurso: type: string description: Identificador do recurso nomeRecurso: type: string description: Nome do recurso rotuloRecurso: type: string description: Rótulo do recurso descricaoRecurso: type: string description: Descrição do recurso (opcional) recursoAcoesRec: description: Representa um recurso e suas respectivas ações type: object required: – idRecurso – nomeRecurso – rotuloRecurso – selecionado properties: idRecurso: type: string description: Identificador do recurso nomeRecurso: type: string description: Nome do recurso rotuloRecurso: type: string description: Rótulo do recurso descricaoRecurso: type: string description: Descrição do recurso (opcional) uri: type: string description: URI do recurso (opcional) acoes: type: array items: type: object allOf: – #/definitions/acaoRec description: Lista com as ações que este recurso possui selecionado: type: boolean description: Indica se o recurso está selecionado na tela acaoRec: description: Representa uma ação de um determinado recurso type: object required: – idAcao – nomeAcao properties: idAcao: type: string description: Identificador da ação nomeAcao: type: string description: Nome da ação rotuloAcao: type: string description: Rotulo da ação recItemPermissao: description: Item para validação da permissão type: object required: – uriRecurso – nomeAcao – atributos properties: uriRecurso: type: string description: URI do recurso nomeAcao: type: string description: Nome ação atributos: type: array items: type: object allOf: – #/definitions/recAtributo minimum: 1 description: Atributos recPermissaoFiltros: description: Permissões e filtros do retorno da validação de permissão type: object required: – uriRecurso – acao – permitido – filtrosCustomizados – filtros properties: uriRecurso: type: string description: URI do recurso acao: type: string description: Ação permitido: type: boolean description: Indica se o recurso tem permissao de acesso filtrosCustomizados: type: array items: type: string minimum: 1 description: lista com as URIS dos filtros customizados que estão ativos para este usuário/recurso/ação filtros: type: array items: type: string minimum: 1 description: lista com expressões json contendo os filtros de dados ativos para este usuário/recurso/ação recAtributo: description: Representa um atributo de um recurso type: object required: – nome – valor properties: nome: type: string description: Nome do atributo valor: type: string description: Valor do atributo recPermissao: description: Representa uma permissão de acesso a um recurso type: object required: – nomeRecurso – permitido properties: nomeRecurso: type: string description: Nome do recurso permitido: type: boolean description: Indica se o acesso é permitido ou não recRecurso: description: Representa um recurso com suas ações type: object required: – uriRecurso – acoesPermissao properties: uriRecurso: type: string description: Identificador do Recurso acoesPermissao: type: array items: type: string minimum: 1 description: Lista de ações que se quer verificar no recurso recRecursoPermissao: description: Representa um recurso com suas ações type: object required: – uriRecurso – acoesPermissao properties: uriRecurso: type: string description: Identificador do Recurso acoesPermissao: type: array items: type: object allOf: – #/definitions/permissaoAcao minimum: 1 description: Ações com sua permissão headerRec: description: Header da grid de consulta de elementos type: object required: – key – name properties: key: type: string description: Identificador da coluna name: type: string description: Nome da coluna papelRec: description: Representa um papel type: object required: – idPapel – nomePapel – descricaoPapel properties: idPapel: type: string description: Identificador do papel nomePapel: type: string description: Nome do papel descricaoPapel: type: string description: Descrição do papel role: description: Representa um papel discriminator: _discriminator type: object required: – id – name – description – _discriminator properties: id: type: string description: Identificador do papel name: type: string description: Nome do papel description: type: string description: Descrição do papel _discriminator: type: string description: roleWithUsers: description: Representa um papel com seus usuários allOf: – #/definitions/role – type: object properties: users: type: array items: type: string description: Usuaríos associados ao papel usuarioPapelRec: description: Representa um usuário, para a tela de papeis type: object required: – idUsuario properties: idUsuario: type: string description: Identificador do usuário nomeUsuario: type: string description: Nome do usuário paginationRec: description: Dados de paginação da grid das telas de consulta type: object required: – count – page – pages – size properties: count: type: integer format: int64 description: Quantidade de itens total page: type: integer format: int64 description: Página atual pages: type: integer format: int64 description: Quantidade de páginas total size: type: integer format: int64 description: Quantidade de itens por página dominioPermissaoPapelRec: description: Representa um domínio, para a tela de permissões do papel type: object properties: idDominio: type: string description: Identificador do domínio nomeDominio: type: string description: Nome do domínio rotuloDominio: type: string description: Rótulo do domínio descricaoDominio: type: string description: Descrição do domínio servicos: type: array items: type: object allOf: – #/definitions/servicoPermissaoPapelRec description: Lista com os serviços que este domínio possui dominioFiltroPapelRec: description: Representa um domínio com os serviços e filtros, para a tela de permissões do papel type: object properties: idDominio: type: string description: Identificador do domínio nomeDominio: type: string description: Nome do domínio servicos: type: array items: type: object allOf: – #/definitions/servicoFiltroRec description: Lista com os serviços que este domínio possui servicoFiltroRec: description: Representa um servico que contém uma lista de filtros type: object properties: idServico: type: string description: Identificador do servico nomeServico: type: string description: Nome do servico rotuloServico: type: string description: Rótulo do servico filtros: type: array items: type: object allOf: – #/definitions/filtroPapelRec description: Lista com os filtros filtroPapelRec: description: Representa um filtro, para a tela de papeis type: object properties: idFiltro: type: string description: Identificador do filtro valores: type: array items: type: object allOf: – #/definitions/campoFiltroPapelRec description: Lista com os campos e valores campoFiltroPapelRec: description: Representa um campo de um filtro, na tela de papeis type: object required: – idCampoFiltro – valorCampo properties: idCampoFiltro: type: string description: Identificador do campo nomeCampo: type: string description: Nome do campo nomeInterno: type: string description: Nome definido como identificador do filtro valorCampo: type: string description: Valor do campo tipoCampo: type: string description: Tipo do campo endpoint: type: string description: Endpoint do serviço de lookup parametros: type: array items: type: string description: Filtros que devem ser enviados como parâmetros do endpoint RecursoPermissao: description: Representa um recurso sobre o qual alguma ação será executada. Seu acesso deve ser autorizado através do uso das permissões type: object required: – idRecursoPermissao – nome – URI – acoes properties: idRecursoPermissao: type: string description: Identificador do Recurso nome: type: string description: Nome do Recurso. Por exemplo, ApuracaoPonto, Colaborador, NotaFiscal, etc.. rotulo: type: string description: Rótulo do Recurso. Por exemplo, Apuracao de ponto, Colaborador, Nota´fiscal, etc.. descricao: type: string description: Descrição do Recurso URI: type: string description: URI do recurso master: type: boolean description: Indica se o recurso é master acoes: type: array items: type: string minimum: 1 description: Lista com as ações associadas a este recurso recAcoesRecurso: description: Representa um recurso com suas respectivas ações type: object required: – idRecurso – nomeRecurso – nomeServico – acoes properties: idRecurso: type: string description: Identificador do recurso nomeRecurso: type: string description: Nome do recurso rotuloRecurso: type: string description: Rótulo do recurso nomeServico: type: string description: Nome do servico acoes: type: array items: type: object allOf: – #/definitions/recAcao minimum: 1 description: Lista com as ações recAcao: description: Representa uma ação que é efetuada sobre um recurso type: object required: – idAcao – nomeAcao properties: idAcao: type: string description: Identificador da ação nomeAcao: type: string description: Nome da ação rotuloAcao: type: string description: Rótulo da ação recursoCompletoRec: description: Representa um recurso e suas propriedades type: object required: – idRecurso – nomeRecurso – rotuloRecurso properties: idRecurso: type: string description: Identificador do recurso nomeRecurso: type: string description: Nome do recurso rotuloRecurso: type: string description: Rótulo do recurso descricaoRecurso: type: string description: Descrição do recurso (opcional) propriedades: type: array items: type: object allOf: – #/definitions/propriedadeRec description: Lista com as propriedades que este recurso possui (opcional) uri: type: string description: URI do recurso propriedadeRec: description: Representa uma propriedade type: object required: – nomePropriedade – valorPropriedade properties: idPropriedade: type: string description: Identificador da propriedade nomePropriedade: type: string description: Nome da propriedade valorPropriedade: type: string description: Valor da propriedade servicoPermissaoPapelRec: description: Representa um serviço, para a tela de permissões do papel type: object properties: idServico: type: string description: Identificador do serviço nomeServico: type: string description: Nome do serviço rotuloServico: type: string description: Rótulo do serviço descricaoServico: type: string description: Descrição do serviço recursos: type: array items: type: object allOf: – #/definitions/recursoPermissaoPapelRec description: Lista com os recursos que este papel tem alguma permissão de acesso recursoPermissaoPapelRec: description: Representa um recurso, para a tela de permissoes do papel type: object properties: idRecurso: type: string description: Identificador do recurso nomeRecurso: type: string description: Nome do recurso rotuloRecurso: type: string description: Rótulo do recurso descricaoRecurso: type: string description: Descrição do recurso filtrosCustomizados: type: array items: type: object allOf: – #/definitions/filtroCustomizadoPermissaoPapelRec description: Lista com os Filtros Customizados deste recurso acoes: type: array items: type: object allOf: – #/definitions/acaoPermissaoPapelRec description: Lista com as ações existentes para este recurso acaoPermissaoPapelRec: description: Representa uma ação, para a tela de permissões do papel type: object required: – idAcao properties: idAcao: type: string description: Identificador da ação nomeAcao: type: string description: Nome da ação rotuloAcao: type: string description: Rótulo da ação permitido: type: boolean description: Indica se o papel tem permissão de execução filtrosCustomizados: type: array items: type: object allOf: – #/definitions/filtroCustomizadoPermissaoPapelRec description: Lista com os filtros customizados ativos para esta ação codigo: type: string description: Código javascript para controle de ABAC filtroCustomizadoPermissaoPapelRec: description: Representa um filtro customizado, para a tela de permissões do papel type: object required: – idFiltroCustomizado properties: idFiltroCustomizado: type: string description: Identificador do filtro customizado nomeFiltroCustomizado: type: string description: Nome do filtro customizado rotuloFiltroCustomizado: type: string description: Rótulo do filtro customizado descricaoFiltroCustomizado: type: string description: Descrição do filtro customizado permissaoAcao: description: Representa uma ação e o resultado de sua permissão type: object required: – nomeAcao – permitido – filtrosCustomizados – filtros properties: nomeAcao: type: string description: Identificador da Ação permitido: type: boolean description: Valor para a permissão filtrosCustomizados: type: array items: type: string minimum: 1 description: lista com as URIS dos filtros customizados que estão ativos para este usuário/recurso/ação filtros: type: array items: type: string minimum: 1 description: lista com expressões json contendo os filtros de dados ativos para este usuário/recurso/ação dominioAcoesPapelRec: description: Representa um domínio, quantidade total e quantidade de ações permitidas para determinado papel type: object required: – idDominio – nomeDominio – rotuloDominio – descricaoDominio – acoesPermitidas – acoesTotais properties: idDominio: type: string description: Identificador do domínio nomeDominio: type: string description: Nome do domínio rotuloDominio: type: string description: Rótulo do domínio descricaoDominio: type: string description: Descrição do domínio acoesPermitidas: type: integer format: int64 description: Quantidade de ações permitidas para o papel dentro do domínio acoesTotais: type: integer format: int64 description: Quantidade total de ações que o domínio possui recDominio: description: Representa um domínio type: object required: – idDominio – nome – rotulo – descricao properties: idDominio: type: string description: Identificador do domínio nome: type: string description: Nome do domínio rotulo: type: string description: Rótulo do domínio descricao: type: string description: Descrição do domínio servicoDominioAcoesPapelRec: description: type: object required: – idServico – nomeServico – rotuloServico – descricaoServico – acoesPermitidas – acoesTotais properties: idServico: type: string description: Identificador do serviço nomeServico: type: string description: Nome do serviço rotuloServico: type: string description: Rótulo do serviço descricaoServico: type: string description: Descrição do serviço acoesPermitidas: type: integer format: int64 description: Quantidade de ações permitidas para o papel dentro do serviço acoesTotais: type: integer format: int64 description: Quantidade total de ações que o serviço possui filtrosRecursosRec: description: Representa todos os filtros associados a um recurso e ação type: object required: – uriRecurso – acao – filtrosCustomizados – filtros properties: uriRecurso: type: string description: URI do recurso acao: type: string description: Ação filtrosCustomizados: type: array items: type: string minimum: 1 description: lista com as URIS dos filtros customizados que estão ativos para este usuário/recurso/ação filtros: type: array items: type: string minimum: 1 description: lista com expressões json contendo os filtros de dados ativos para este usuário/recurso/ação recPapel: description: type: object required: – idPapel – nome properties: idPapel: type: string description: Identificador do Papel nome: type: string description: Nome do Papel descricao: type: string description: Descrição do Papel Usuario: description: Representa um usuário type: object required: – idUsuario – nome – nomeCompleto – email – bloqueado properties: idUsuario: type: string description: Identificador do Usuário nome: type: string description: Nome do Usuário (username) nomeCompleto: type: string description: Nome completo do Usuário descricao: type: string description: Descrição do Usuário email: type: string description: Endereço de email do usuário bloqueado: type: boolean description: Indica se o usuário está bloqueado papelBasicoRec: description: Representa um papel e suas propriedades type: object required: – idPapel – nomePapel – descricaoPapel – usuarios – filtros properties: idPapel: type: string description: Identificador do papel nomePapel: type: string description: Nome do papel descricaoPapel: type: string description: Descrição do papel usuarios: type: object allOf: – #/definitions/usuariosPaginationRec description: Lista com os usuários que este papel possui filtros: type: array items: type: object allOf: – #/definitions/dominioSimplificadoRec minimum: 1 description: Lista com os domínios dos filtros que este papel possui. O conteúdo dos domínios é obtido sob demanda. propriedades: type: array items: type: object allOf: – #/definitions/propriedadeRec description: Lista com as propriedades do papel (opcional) dominioSimplificadoRec: description: Representa um domínio simplificado, sem seus serviços type: object required: – idDominio – nomeDominio – rotuloDominio – descricaoDominio properties: idDominio: type: string description: Identificador do dominio nomeDominio: type: string description: Nome do domínio rotuloDominio: type: string description: Rótulo do domínio descricaoDominio: type: string description: Descrição do domínio usuariosPaginationRec: description: Representa uma lista de usuários com suporte a paginação type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: – #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: – #/definitions/usuarioRec minimum: 1 description: Contém as linhas com os usuários pagination: type: object allOf: – #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC usuarioRec: description: Representa um usuário simplificado, utilizado na grid de consulta type: object required: – idUsuario – nome – nomeCompleto – email properties: idUsuario: type: string description: Identificador do usuário nome: type: string description: Nome do usuário nomeCompleto: type: string description: Nome completo do usuário email: type: string description: Endereço de email do usuário dominioPermissaoRec: description: Representa um domínio, para a tela de substituição type: object required: – idDominio – nomeDominio – papeis properties: idDominio: type: string description: Identificador do domínio nomeDominio: type: string description: Nome do domínio papeis: type: array items: type: object allOf: – #/definitions/papelPermissaoRec minimum: 1 description: Lista com os papéis que o usuário possui, dentro deste domínio papelPermissaoRec: description: Representa um papel, para a tela de substituição type: object required: – idPapel – nomePapel – servicos properties: idPapel: type: string description: Identificador do papel nomePapel: type: string description: Nome do papel servicos: type: array items: type: object allOf: – #/definitions/servicoPermissaoRec minimum: 1 description: Lista com os serviços que este papel tem alguma permissão de acesso papelCompletoRec: description: Representa um papel e suas propriedades type: object required: – idPapel – nomePapel – descricaoPapel – usuarios – filtros – permissoes properties: idPapel: type: string description: Identificador do papel nomePapel: type: string description: Nome do papel descricaoPapel: type: string description: Descrição do papel usuarios: type: object allOf: – #/definitions/usuariosPaginationRec description: Lista com os usuários que este papel possui filtros: type: array items: type: object allOf: – #/definitions/dominioSimplificadoRec minimum: 1 description: Lista com os domínios dos filtros que este papel possui. O conteúdo dos domínios é obtido sob demanda. permissoes: type: array items: type: object allOf: – #/definitions/dominioPermissaoPapelRec minimum: 1 description: Lista com os domínios dos recursos que este papel possui. Apenas os domínios que possuem algum recurso liberado serão listados propriedades: type: array items: type: object allOf: – #/definitions/propriedadeRec description: Lista com as propriedades do papel (opcional) recPropriedade: description: Representa uma propriedade de um tenant/recurso/papel/usuário type: object required: – idPropriedade – nome – valor properties: idPropriedade: type: string description: Identificador da propriedade nome: type: string description: Nome da propriedade valor: type: string description: Valor da propriedade Papel: description: Representa um papel de usuário type: object required: – idPapel – nome properties: idPapel: type: string description: Identificador do Papel nome: type: string description: Nome do Papel descricao: type: string description: Descrição do Papel pageRequest: description: Input para listagem de entidade type: object required: – offset – size properties: offset: type: integer format: int64 description: size: type: integer format: int64 description: pagedResults: description: Output para listagem da entidade type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/Papel minimum: 1 description: id: description: type: object required: – id properties: id: type: string description: acaoFiltroSimplesRec: description: Representa um filtro simples type: object required: – idAcao properties: idAcao: type: string description: Identificador da ação filtrosCustomizados: type: array items: type: object allOf: – #/definitions/filtroCustomizadoSimplesRec description: Lista com os filtros customizados associados a esta ação (opcional) filtros: type: array items: type: object allOf: – #/definitions/filtroSimplesRec description: Lista com os filtros simples associados a esta ação filtroCustomizadoSimplesRec: description: Representa um filtro customizado type: object required: – idFiltroCustomizado – checked properties: idFiltroCustomizado: type: string description: Identificador do filtro customizado checked: type: boolean description: Indica se está em uso ou não filtroSimplesRec: description: Representa um filtro simples type: object required: – idFiltro properties: idFiltro: type: string description: Identificador do filtro campos: type: array items: type: object allOf: – #/definitions/campoFiltroSimplesRec description: Lista com os campos que compoem este filtro campoFiltroSimplesRec: description: Representa um campo de um filtro simples type: object required: – idCampoFiltro – valorCampo properties: idCampoFiltro: type: string description: Identificador do campo do filtro valorCampo: type: string description: Valor do campo do filtro filterField: description: Campo de filtro de dados (abrangência) type: object required: – name – type properties: name: type: string description: Nome do campo type: type: string description: Tipo do campo de filtro servicoPermissaoRec: description: Representa um serviço, para a tela de substituição type: object required: – idServico – nomeServico – recursos properties: idServico: type: string description: Identificador do serviço nomeServico: type: string description: Nome do serviço recursos: type: array items: type: object allOf: – #/definitions/recursoPermissaoRec minimum: 1 description: Lista com os recursos que este papel tem alguma permissão de acesso recursoPermissaoRec: description: Representa um recurso, para a tela de substituição type: object required: – idRecurso – nomeRecurso – rotuloRecurso – acoes properties: idRecurso: type: string description: Identificador do recurso nomeRecurso: type: string description: Nome do recurso rotuloRecurso: type: string description: Rótulo do recurso acoes: type: array items: type: object allOf: – #/definitions/acaoPermissaoRec minimum: 1 description: Lista com as ações existentes para este recurso acaoPermissaoRec: description: Representa uma ação, para a tela de substituição type: object required: – idAcao – nomeAcao – permitido properties: idAcao: type: string description: Identificador da ação nomeAcao: type: string description: Nome da ação rotuloAcao: type: string description: Rótulo da ação permitido: type: boolean description: Indica se o papel tem permissão de execução serviceDomain: description: Dados de um serviço com o seu domínio type: object required: – serviceId – serviceName – domainId – domainName properties: serviceId: type: string description: Identificador do serviço serviceName: type: string description: Nome do serviço domainId: type: string description: Identificador do domínio domainName: type: string description: Nome do domínio 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