Usuarios

web_interface

34 views 01/07/2019 11/11/2019 integrador 0

2.0info: 20.3.0 web_interface x-senior-domain: usuarios x-senior-domain-path: usuarios x-senior-service-path: web_interface contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/usuariossecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /web_interface/queries/listaTodosPapeis: post: description: Retorna uma lista com todos os papéis, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Indica qual página deve ser exibida na grid com todos os papéis count: type: integer format: int64 description: Indica qual a quantidade de papéis é mostrada em cada página sort_by: type: string description: Nome do campo pelo qual os papéis são ordenados na grid sort_order: type: string description: Indica se a ordenação deve ser em ordem ASC ou DESC nome: type: string description: Nome utilizado como filtro responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: #/definitions/papelRec minimum: 1 description: Contém as linhas com os papéis pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os papéis, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Indica qual página deve ser exibida na grid com todos os papéis in: query type: integer format: int64 – name: count description: Indica qual a quantidade de papéis é mostrada em cada página in: query type: integer format: int64 – name: sort_by description: Nome do campo pelo qual os papéis são ordenados na grid in: query type: string – name: sort_order description: Indica se a ordenação deve ser em ordem ASC ou DESC in: query type: string – name: nome description: Nome utilizado como filtro in: query type: string responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: #/definitions/papelRec minimum: 1 description: Contém as linhas com os papéis pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError /web_interface/queries/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 /web_interface/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 /web_interface/queries/listaTodosTenants: post: description: Retorna uma lista com todos os tenants, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Indica qual página deve ser exibida na grid com todos os tenants count: type: integer format: int64 description: Indica qual a quantidade de tenants é mostrada em cada página sort_by: type: string description: Nome do campo pelo qual os tenants 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/tenantRec minimum: 1 description: Contém as linhas com os tenants pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os tenants, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Indica qual página deve ser exibida na grid com todos os tenants in: query type: integer format: int64 – name: count description: Indica qual a quantidade de tenants é mostrada em cada página in: query type: integer format: int64 – name: sort_by description: Nome do campo pelo qual os tenants 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/tenantRec minimum: 1 description: Contém as linhas com os tenants pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError /web_interface/queries/listaTodosUsuarios: post: description: Retorna uma lista com todos os usuarios, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Indica qual página deve ser exibida na grid com todos os usuários count: type: integer format: int64 description: Indica qual a quantidade de usuários é mostrada em cada página sort_by: type: string description: Nome do campo pelo qual os usuários são ordenados na grid sort_order: type: string description: Indica se a ordenação deve ser em ordem ASC ou DESC nome: type: string description: Nome utilizado como filtro responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: #/definitions/usuarioRec minimum: 1 description: Contém as linhas com os usuários pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os usuarios, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Indica qual página deve ser exibida na grid com todos os usuários in: query type: integer format: int64 – name: count description: Indica qual a quantidade de usuários é mostrada em cada página in: query type: integer format: int64 – name: sort_by description: Nome do campo pelo qual os usuários são ordenados na grid in: query type: string – name: sort_order description: Indica se a ordenação deve ser em ordem ASC ou DESC in: query type: string – name: nome description: Nome utilizado como filtro in: query type: string responses: 200: description: Ok schema: type: object required: – header – rows – pagination – sort_by – sort_order properties: header: type: array items: type: object allOf: #/definitions/headerRec minimum: 1 description: Contém o header da grid rows: type: array items: type: object allOf: #/definitions/usuarioRec minimum: 1 description: Contém as linhas com os usuários pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid sort_by: type: string description: Contém o nome do campo pelo qual é efetuada a ordenação dos dados sort_order: type: string description: Indica se a ordenação deve ser ASC ou DESC default: description: Error response schema: #/definitions/genericError /web_interface/queries/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 /web_interface/queries/listaPapeisUsuario: 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 /web_interface/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 /web_interface/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 /web_interface/queries/listaUsuariosComFiltro: post: description: Retorna uma lista de usuários em ordem alfabética, de acordo com o filtro passado como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: nome: type: string description: Nome do usuário utilizado como filtro. Se nada for passado, retorna todos os usuários responses: 200: description: Ok schema: type: object properties: usuarios: type: array items: type: object allOf: #/definitions/usuarioRec description: Lista com os usuários filtrados default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de usuários em ordem alfabética, de acordo com o filtro passado como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: nome description: Nome do usuário utilizado como filtro. Se nada for passado, retorna todos os usuários in: query type: string responses: 200: description: Ok schema: type: object properties: usuarios: type: array items: type: object allOf: #/definitions/usuarioRec description: Lista com os usuários filtrados default: description: Error response schema: #/definitions/genericError /web_interface/queries/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 /web_interface/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 /web_interface/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 /web_interface/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 /web_interface/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: 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: pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid default: description: Error response schema: #/definitions/genericError /web_interface/queries/listPendenciesWithError: post: description: Retorna lista com as pendencias que falharam na integração tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Indica qual página deve ser exibida na grid com todos os recursos count: type: integer format: int64 description: Indica qual a quantidade de pendencias é mostrada em cada página responses: 200: description: Ok schema: type: object required: – pendencies – pagination properties: pendencies: type: array items: type: object allOf: #/definitions/pendenciesWithError minimum: 1 description: pendencias com problema de sincronização pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid default: description: Error response schema: #/definitions/genericError get: description: Retorna lista com as pendencias que falharam na integração tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Indica qual página deve ser exibida na grid com todos os recursos in: query type: integer format: int64 – name: count description: Indica qual a quantidade de pendencias é mostrada em cada página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – pendencies – pagination properties: pendencies: type: array items: type: object allOf: #/definitions/pendenciesWithError minimum: 1 description: pendencias com problema de sincronização pagination: type: object allOf: #/definitions/paginationRec description: Contém os dados para a paginação da grid default: description: Error response schema: #/definitions/genericError /web_interface/queries/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 /web_interface/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 /web_interface/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 /web_interface/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 /web_interface/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 /web_interface/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 /web_interface/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 /web_interface/queries/obtemTenant: post: description: Busca um tenant através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idTenant properties: idTenant: type: string description: Identificador do tenant responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: type: object allOf: #/definitions/tenantCompletoRec description: Informações sobre o tenant default: description: Error response schema: #/definitions/genericError get: description: Busca um tenant através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idTenant description: Identificador do tenant in: query required: true type: string responses: 200: description: Ok schema: type: object required: – tenant properties: tenant: type: object allOf: #/definitions/tenantCompletoRec description: Informações sobre o tenant default: description: Error response schema: #/definitions/genericError /web_interface/queries/obtemUsuario: post: description: Obtém um usuário através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario properties: idUsuario: type: string description: Identificador do usuário responses: 200: description: Ok schema: type: object required: – usuario properties: usuario: type: object allOf: #/definitions/usuarioCompletoRec description: Informações sobre o usuário default: description: Error response schema: #/definitions/genericError get: description: Obtém um usuário através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idUsuario description: Identificador do usuário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – usuario properties: usuario: type: object allOf: #/definitions/usuarioCompletoRec description: Informações sobre o usuário default: description: Error response schema: #/definitions/genericError /web_interface/queries/obtemPropriedadesUsuario: post: description: Busca todas as propriedades de um usuário, através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario properties: idUsuario: type: string description: Identificador do usuário responses: 200: description: Ok schema: type: object required: – propriedades properties: propriedades: type: array items: type: object allOf: #/definitions/propriedadeRec minimum: 1 description: Lista com as propriedades que este usuário possui default: description: Error response schema: #/definitions/genericError get: description: Busca todas as propriedades de um usuário, através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idUsuario description: Identificador do usuário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – propriedades properties: propriedades: type: array items: type: object allOf: #/definitions/propriedadeRec minimum: 1 description: Lista com as propriedades que este usuário possui default: description: Error response schema: #/definitions/genericError /web_interface/queries/verificaConexaoLDAP: post: description: Verifica se os dados de conexão LDAP estão corretos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – servidorLDAP properties: servidorLDAP: type: object allOf: #/definitions/dadosConexaoLDAPrec description: Dados para conexão ao servidor LDAP responses: 200: description: Ok schema: type: object required: – conexaoOk properties: conexaoOk: type: boolean description: Booleano indicando se a conexão foi bem sucedida default: description: Error response schema: #/definitions/genericError /web_interface/queries/listaSubstituicoesPeriodo: post: description: Retorna todas as substituições que um determinado usuário participa, tanto como substituto como titular, em um determinado período tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – dataInicial – dataFinal properties: idUsuarioTitular: type: string description: Identificador do usuário titular idUsuarioSubstituto: type: string description: Identificador do usuário substituto dataInicial: type: string format: date description: Data inicial dataFinal: type: string format: date description: Data final responses: 200: description: Ok schema: type: object required: – substituicoes properties: substituicoes: type: array items: type: object allOf: #/definitions/substituicaoListaRec minimum: 1 description: Lista com as substituições que satisfazem os critérios de pesquisa default: description: Error response schema: #/definitions/genericError get: description: Retorna todas as substituições que um determinado usuário participa, tanto como substituto como titular, em um determinado período tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idUsuarioTitular description: Identificador do usuário titular in: query type: string – name: idUsuarioSubstituto description: Identificador do usuário substituto in: query type: string – name: dataInicial description: Data inicial in: query required: true type: string format: date – name: dataFinal description: Data final in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – substituicoes properties: substituicoes: type: array items: type: object allOf: #/definitions/substituicaoListaRec minimum: 1 description: Lista com as substituições que satisfazem os critérios de pesquisa default: description: Error response schema: #/definitions/genericError /web_interface/queries/obtemSubstituicao: post: description: Obtém uma substituição através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idSubstituicao properties: idSubstituicao: type: string description: Identificador da substituição responses: 200: description: Ok schema: type: object required: – idUsuarioTitular – nomeUsuarioTitular – dataInicial – dataFinal – motivoSubstituicao – substituicoes properties: idUsuarioTitular: type: string description: Identificador do usuário titular nomeUsuarioTitular: type: string description: Nome do usuário titular dataInicial: type: string format: date description: Data inicial dataFinal: type: string format: date description: Data final motivoSubstituicao: type: string description: Motivo da substituição substituicoes: type: array items: type: object allOf: #/definitions/itemSubstituicaoConsultaDominioRec minimum: 1 description: Lista com as substituições efetuadas default: description: Error response schema: #/definitions/genericError get: description: Obtém uma substituição através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idSubstituicao description: Identificador da substituição in: query required: true type: string responses: 200: description: Ok schema: type: object required: – idUsuarioTitular – nomeUsuarioTitular – dataInicial – dataFinal – motivoSubstituicao – substituicoes properties: idUsuarioTitular: type: string description: Identificador do usuário titular nomeUsuarioTitular: type: string description: Nome do usuário titular dataInicial: type: string format: date description: Data inicial dataFinal: type: string format: date description: Data final motivoSubstituicao: type: string description: Motivo da substituição substituicoes: type: array items: type: object allOf: #/definitions/itemSubstituicaoConsultaDominioRec minimum: 1 description: Lista com as substituições efetuadas default: description: Error response schema: #/definitions/genericError /web_interface/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 /web_interface/queries/obtemGrupo: post: description: Busca um grupo através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idGrupo properties: idGrupo: type: string description: Identificador do grupo responses: 200: description: Ok schema: type: object required: – grupo properties: grupo: type: object allOf: #/definitions/grupoCompletoRec description: Informações sobre o grupo default: description: Error response schema: #/definitions/genericError get: description: Busca um grupo através do seu identificador tags: – Queries x-senior-visibility: PUBLIC parameters: – name: idGrupo description: Identificador do grupo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – grupo properties: grupo: type: object allOf: #/definitions/grupoCompletoRec description: Informações sobre o grupo default: description: Error response schema: #/definitions/genericError /web_interface/queries/obtemConfiguracaoLembrarMe: post: description: Busca as configurações do tenant referente a funcionalidade de Lembrar Me na tela de login tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: tenantDomain: type: string description: Domínio do tenant responses: 200: description: Ok schema: type: object required: – allowRememberMe – expirationRememberMe properties: allowRememberMe: type: boolean description: Indica se permite ou não, mostrar a opção de Lembrar Me na tela de login expirationRememberMe: type: integer format: int64 description: Tempo de duração do cookie ao marcar a opção Lembrar Me na tela de login default: description: Error response schema: #/definitions/genericError get: description: Busca as configurações do tenant referente a funcionalidade de Lembrar Me na tela de login tags: – Queries x-senior-visibility: PUBLIC parameters: – name: tenantDomain description: Domínio do tenant in: query type: string responses: 200: description: Ok schema: type: object required: – allowRememberMe – expirationRememberMe properties: allowRememberMe: type: boolean description: Indica se permite ou não, mostrar a opção de Lembrar Me na tela de login expirationRememberMe: type: integer format: int64 description: Tempo de duração do cookie ao marcar a opção Lembrar Me na tela de login default: description: Error response schema: #/definitions/genericError /web_interface/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /web_interface/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /web_interface/actions/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 /web_interface/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 /web_interface/actions/atualizaUsuario: post: description: Atualiza um usuário tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuario – nomeCompleto – email – bloqueado – papeis properties: idUsuario: type: string description: Identificador do usuário nomeCompleto: type: string description: Nome completo do usuário email: type: string description: Endereço de email do usuário descricao: type: string description: Descrição do usuário (opcional) bloqueado: type: boolean description: Indica se o usuário está bloqueado trocaSenha: type: boolean description: Indica se o usuário precisa trocar de senha no próximo logon default: false papeis: type: array items: type: string minimum: 1 description: Lista com os identificadores dos papéis que este usuário está associado foto: type: string description: Foto do usuário, em Base64 (opcional) localidade: type: string description: Localização do usuário propriedades: type: array items: type: object allOf: #/definitions/propriedadeRec description: Lista com as propriedades que este usuário possui (opcional) responses: 200: description: Ok schema: type: object required: – idUsuario properties: idUsuario: type: string description: Identificador do usuário recém alterado default: description: Error response schema: #/definitions/genericError /web_interface/actions/atualizaLocalidadeUsuario: post: description: Atualiza localidade de um usuário tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – localidade properties: localidade: type: string description: localidade do usuário ex: pt-BR responses: 200: description: Ok schema: type: object required: – idUsuario properties: idUsuario: type: string description: Identificador do usuário recém alterado default: description: Error response schema: #/definitions/genericError /web_interface/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 /web_interface/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 /web_interface/actions/insereUsuario: post: description: Insere um novo usuario na base tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nome – nomeCompleto – email – senha – confirmacaoSenha – bloqueado – trocaSenha – papeis properties: nome: type: string description: Nome (username) do usuário nomeCompleto: type: string description: Nome completo do usuário email: type: string description: Endereço de email do usuário senha: type: string description: Senha do usuário confirmacaoSenha: type: string description: Confirmação da senha do usuário descricao: type: string description: Descrição do usuário (opcional) bloqueado: type: boolean description: Indica se o usuário está ou não bloqueado trocaSenha: type: boolean description: Indica se o usuário precisa trocar a senha no próximo logon papeis: type: array items: type: string minimum: 1 description: Lista com os identificadores dos papéis associados a este usuário foto: type: string description: Foto do usuário, em Base64. (opcional) localidade: type: string description: Localidade do usuário propriedades: type: array items: type: object allOf: #/definitions/propriedadeRec description: Lista com as propriedades que este usuário possui (opcional) responses: 200: description: Ok schema: type: object required: – idUsuario properties: idUsuario: type: string description: Identificador do usuário recém criado default: description: Error response schema: #/definitions/genericError /web_interface/actions/substituiUsuario: post: description: Efetua uma substituição de usuário tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idUsuarioTitular – dataInicial – dataFinal – motivoSubstituicao – substituicoes properties: idUsuarioTitular: type: string description: Identificador do usuário titular dataInicial: type: string format: date description: Data inicial dataFinal: type: string format: date description: Data final motivoSubstituicao: type: string description: Motivo da substituição substituicoes: type: array items: type: object allOf: #/definitions/itemSubstituicaoInclusaoRec minimum: 1 description: Lista com as substituições efetuadas responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um ok só para API Manager não retornar erro default: description: Error response schema: #/definitions/genericError /web_interface/actions/atualizaSubstituicaoUsuario: post: description: Atualiza uma substituição de usuário tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idSubstituicao – dataInicial – dataFinal – motivoSubstituicao – substituicoes properties: idSubstituicao: type: string description: Identificador da substituicao dataInicial: type: string format: date description: Data inicial dataFinal: type: string format: date description: Data final motivoSubstituicao: type: string description: Motivo da substituição substituicoes: type: array items: type: object allOf: #/definitions/itemSubstituicaoAlteracaoRec minimum: 1 description: Lista com as substituições efetuadas responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna um ok só para API Manager não retornar erro default: description: Error response schema: #/definitions/genericError /web_interface/actions/apagaSubstituicao: post: description: Apaga uma substituição de usuário tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idSubstituicao properties: idSubstituicao: type: string description: Identificador da substituicao responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna ok apenas para o API Manager não retornar erro default: description: Error response schema: #/definitions/genericError /web_interface/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 /web_interface/actions/atualizaGrupo: post: description: Atualiza um grupo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idGrupo – nomeGrupo – usuarios properties: idGrupo: type: string description: Identificador do grupo nomeGrupo: type: string description: Nome do grupo descricaoGrupo: type: string description: Descrição do grupo emailGrupo: type: string description: Email do grupo usuarios: type: array items: type: object allOf: #/definitions/usuarioGrupoRec minimum: 1 description: Lista com os usuários associados a este grupo responses: 200: description: Ok schema: type: object required: – idGrupo properties: idGrupo: type: string description: Identificador do grupo recém alterado default: description: Error response schema: #/definitions/genericError /web_interface/actions/insereGrupo: post: description: Insere um novo grupo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeGrupo – descricaoGrupo – emailGrupo – usuarios properties: nomeGrupo: type: string description: Nome do grupo descricaoGrupo: type: string description: Descrição do grupo (opcional) emailGrupo: type: string description: Email do grupo (opcional) usuarios: type: array items: type: object allOf: #/definitions/usuarioGrupoRec minimum: 1 description: Lista com os usuários associados a este grupo responses: 200: description: Ok schema: type: object required: – idGrupo properties: idGrupo: type: string description: Identificador do grupo recém adicionado default: description: Error response schema: #/definitions/genericError definitions: authType: description: Tipo de autenticação do tenant type: string enum: – G7 – G5 – LDAP – SAML userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT headerRec: description: Header da grid de consulta de elementos type: object required: – key – name properties: key: type: string description: Identificador da coluna name: type: string description: Nome da coluna papelRec: description: Representa um papel type: object required: – idPapel – nomePapel – descricaoPapel properties: idPapel: type: string description: Identificador do papel nomePapel: type: string description: Nome do papel descricaoPapel: type: string description: Descrição do papel 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) 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 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 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 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 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) 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 tenantRec: description: Representa um tenant type: object required: – idTenant – nomeTenant properties: idTenant: type: string description: Identificador do tenant nomeTenant: type: string description: Nome do tenant pendenciesWithError: description: Representa uma pendencia de integração de usuário type: object required: – id – idItem – tableToReplicate – error – operation – createdAt – lastAttempt properties: id: type: string description: id da pendencia idItem: type: string description: idItem com falha na integração tableToReplicate: type: string description: nome da tabela da G5 para ser replicada error: type: string description: mensagem de erro do usuário com falha na integração operation: type: string description: nome da operação createdAt: type: string format: date-time description: data e hora de criação da pendencia lastAttempt: type: string format: date-time description: data e hora da última tentativa de sincronização paginationRec: description: Dados de paginação da grid das telas de consulta type: object required: – count – page – pages – size properties: count: type: integer format: int64 description: Quantidade de itens total page: type: integer format: int64 description: Página atual pages: type: integer format: int64 description: Quantidade de páginas total size: type: integer format: int64 description: Quantidade de itens por página substituicaoListaRec: description: Representa uma substituição de usuário type: object required: – idSubstituicao – nomeUsuarioTitular – usuariosSubstitutos – dataInicial – dataFinal properties: idSubstituicao: type: string description: Identificador da substituição nomeUsuarioTitular: type: string description: Nome do usuario titular usuariosSubstitutos: type: string description: Usuário(s) substituto(s) dataInicial: type: string format: date description: Data Inicial dataFinal: type: string format: date description: Data Final itemSubstituicaoConsultaDominioRec: description: Representa um domínio, para a tela de substituições type: object required: – idDominio – nomeDominio – papeis properties: idDominio: type: string description: Identificador do dominio nomeDominio: type: string description: Nome do dominio papeis: type: array items: type: object allOf: #/definitions/itemSubstituicaoConsultaPapelRec minimum: 1 description: Lista com os papéis que o usuário possui, dentro deste domínio itemSubstituicaoConsultaPapelRec: description: Representa um papel, para a tela de substituições type: object required: – idPapel – nomePapel – idItemSubstituicao – substituto – servicos properties: idPapel: type: string description: Identificador do papel nomePapel: type: string description: Nome do papel idItemSubstituicao: type: string description: Identificador do item da substituicao substituto: type: object allOf: #/definitions/itemSubstituicaoConsultaUsuarioRec description: substituição 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 itemSubstituicaoConsultaUsuarioRec: description: Representa um usuário substituído type: object required: – idUsuario – nomeUsuario properties: idUsuario: type: string description: Identificador do usuário nomeUsuario: type: string description: Nome do usuário itemSubstituicaoInclusaoRec: description: Representa uma nova substituição, para a tela de substituições type: object required: – idDominio – idPapel – idUsuarioSubstituto properties: idDominio: type: string description: Identificador do dominio idPapel: type: string description: Identificador do papel idUsuarioSubstituto: type: string description: Identificador do usuário substituto itemSubstituicaoAlteracaoRec: description: Representa uma substituição já existente, para a tela de substituições type: object required: – idDominio – idPapel properties: idItemSubstituicao: type: string description: Identificador do item idDominio: type: string description: Identificador do dominio idPapel: type: string description: Identificador do papel idUsuarioSubstituto: type: string description: Identificador do usuário destino. Se vier em branco, indica que esta substituição foi excluída. tenantCompletoRec: description: Representa um tenant type: object required: – idTenant – dominioTenant – nome – primeiroNomeAdmin – sobrenomeAdmin – emailAdmin – senhaTamanhoMinimo – senhaTamanhoMaximo – senhaNumeros – senhaMinusculas – senhaMaiusculas – senhaEspeciais – key – secret – tipoAutenticacao – multiplosTokens – controleOrigemAcessoHabilitado – servidorEmail – servidorLDAP – master – tempoExpiracaoLembrarMe properties: idTenant: type: string description: Identificador do tenant dominioTenant: type: string description: Domínio do tenant. De preferência utilize no formato de namespace: por exemplo: hcm.senior.com.br, tenant1.com.br, etc… nome: type: string description: Nome do tenant. Nome curto do tenant, sem espaços nem caracteres especiais. Por exemplo: HCM, Tenant1, ERP, etc.. primeiroNomeAdmin: type: string description: Primeiro nome do administrador sobrenomeAdmin: type: string description: Sobrenome do administrador emailAdmin: type: string description: Email do administrador senhaTamanhoMinimo: type: integer format: int64 description: Quantidade máxima de caracteres da senha senhaTamanhoMaximo: type: integer format: int64 description: Quantidade mínima de caracteres da senha senhaNumeros: type: boolean description: Indica se devem existir caracteres numéricos na senha senhaMinusculas: type: boolean description: Indica se devem existir caracteres minúsculos na senha senhaMaiusculas: type: boolean description: Indica se devem existir caracteres maiúsculos na senha senhaEspeciais: type: boolean description: Indica se devem existir caracteres especiais na senha applicationName: type: string description: O nome da aplicação desse tenant no API Manager key: type: string description: chave de acesso ao portal, obtido no API Manager secret: type: string description: segredo para acesso ao portal, obtido no API Manager tipoAutenticacao: type: integer format: int64 description: Tipo de autenticação utilizada por este tenant authenticationTypes: type: array items: type: string allOf: – #/definitions/authType description: Tipos de authenticação disponiíveis no tenant multiplosTokens: type: boolean description: Indica se para cada sessão do usuário deve ser gerado um novo token assuntoEmailTrocaSenha: type: string description: Assunto do e-mail enviado ao usuário para a troca de senha. templateEmailTrocaSenha: type: string description: Texto do e-mail enviado ao usuário para a troca de senha. controleOrigemAcessoHabilitado: type: boolean description: Indica se o controle de origem de acesso está habilitado faixasIpsValidos: type: array items: type: object allOf: #/definitions/recFaixaIpsValidos description: As faixas de IPs válidos para o controle de origem de acesso servidorEmail: type: object allOf: #/definitions/dadosConexaoEmailRec description: Dados para conexão a um servidor SMTP servidorLDAP: type: object allOf: #/definitions/dadosLDAPrec description: Dados para conexão a um servidor LDAP master: type: boolean description: Indica se o tenant é master ativo: type: boolean description: Indica se o tenant está ativo localidade: type: string description: localidade do tenant urlTelaRedefinicaoSenha: type: string description: Url da tela de redefinição de senha. Se não for informado, irá utilizar a tela padrão da plataforma. permiteAlterarSenhaG5: type: boolean description: Indica se o tenant permite que os usuários alterem a senha pela plataforma quando o tipo de autenticação é G5. Se permitir, o usuário poderá alterar a sua senha pela plataforma e passará a utilizar essa senha no login da G7. Porém, a senha no SGU não será alterada, continuará a antiga. Se a senha do SGU for alterada após o usuário alterar na G7, passará a valer a senha do SGU novamente. default: false urlAposLogoff: type: string description: URL para redirecionamento após a realização do Logoff loginComLembrarMeHabilitado: type: boolean description: Permite que o usuário ative a opção de Lembrar Me no login. tempoExpiracaoLembrarMe: type: integer format: int64 description: Tempo de duração do cookie ao marcar a opção Lembrar Me na tela de login samlRedirectUrl: type: string description: URL de redirecionamento a ser utilizada pela requisição SAML idpEntityId: type: string description: Id da entidade do Identity Provider spEntityId: type: string description: Id da entidade do Service Provider samlLoginUrl: type: string description: URL do servidor SAML para realizar o login samlLogoffUrl: type: string description: URL do servidor SAML para realizar o logoff samlClaimUsername: type: string description: Claim que define o username do usuário samlClaimEmail: type: string description: Claim que define o email do usuário samlClaimName: type: string description: Claim que define o nome do usuário samlPapeis: type: array items: type: string description: Papel(eis) em que os novos usuários devem ser cadastrados ao utilizar autenticação SAML samlUseClaimUsername: type: boolean description: Define se a claim username será utilizada para definir o usuário subscriptionTier: type: string description: Nivel de inscrição do tenant (Valores válidos são listados pela primitiva usuarios.userManager.listAvailableTiers) replicationYieldThreshold: type: integer format: int64 description: O número de usuários limite a serem replicados antes da thread conceder lugar para outras executarem alterarSenhaAposLogin: type: boolean description: Indica se novos usuários do tenant devem vir com o opção para alterar a senha após efetuar o primeiro login ativa por padrão. Mesmo com essa opção ativa o admin no cadastro de usuário poderá optar por não obrigar o usuário alterar a senha após realizar o login. recFaixaIpsValidos: description: Uma faixa de IPs válidos para o controle de origem de acesso type: object required: – valorInicial properties: valorInicial: type: string description: O valor inicial da faixa de IP valorFinal: type: string description: O valor final da faixa de IP dadosConexaoEmailRec: description: Representa os dados de conexão a um servidor SMTP type: object required: – host – port – user – password – requiresAuthentication – SSLTrustEnabled – TLSEnabled properties: host: type: string description: Nome do servidor de email port: type: integer format: int64 description: Porta IP do servidor de email user: type: string description: Usuário do servidor SMTP password: type: string description: Senha do usuário requiresAuthentication: type: boolean description: Indica se a autenticação é necessária ou não SSLTrustEnabled: type: boolean description: SSL Trust habilitado TLSEnabled: type: boolean description: TLS habilitado dadosConexaoLDAPrec: description: Representa os dados para conexão a um servidor LDAP discriminator: _discriminator type: object required: – host – port – SSLEnabled – user – password – searchBase – objectClass – userAttribute – usernameAttribute – descriptionAttribute – emailAttribute – userSearchFilter – userListFilter – _discriminator properties: host: type: string description: Nome do servidor LDAP port: type: integer format: int64 description: Porta IP do servidor LDAP SSLEnabled: type: boolean description: Indica se deve utilizar SSL para conexão user: type: string description: Usuário admin do servidor LDAP password: type: string description: Senha do usuário admin searchBase: type: string description: Endereço base para pesquisa dentro do servidor LDAP objectClass: type: string description: Nome do classe que representa um usuário, no LDAP userAttribute: type: string description: Nome do atributo que representa individualmente um usuário. Pode ser seu id, email, etc.. usernameAttribute: type: string description: Nome do atributo que contém o nome do usuário descriptionAttribute: type: string description: Nome do atributo que contém a descrição do usuário emailAttribute: type: string description: Nome do atributo que contém o email do usuário userSearchFilter: type: string description: Critério de pesquisa de usuários userListFilter: type: string description: Nome da classe que será retornada na pesquisa defaultRoles: type: array items: type: string description: Nomes de papeis padrão para os usuários importados rolesSearchBase: type: string description: Endereço base para pesquisa de papéis no servidor LDAP rolesSearchFilter: type: string description: Filtro para pesquisa de papéis no servidor LDAP roleNameAttribute: type: string description: Nome do atributo que contém o nome do papel. O valor desse atributo no servidor LDAP precisa ser igual ao valor do atributo informado no campo `userMemberOfAttribute` roleDescriptionAttribute: type: string description: Nome do atributo que contém a descrição do papel userMemberOfAttribute: type: string description: Nome do attributo do usuário que contém os papéis a quais ele está associado. O valor desse atributo no servidor LDAP precisa ser igual ao valor do atributo informado no campo `roleNameAttribute` _discriminator: type: string description: dadosLDAPrec: description: Representa os dados de configuração com o servidor LDAP allOf: – #/definitions/dadosConexaoLDAPrec – type: object required: – migrated properties: migrated: type: boolean description: Indicativo de autenticação LDAP gerenciada pelo serviço da Senior (quando falso, a autenticação com LDAP é gerenciada pelo Identity Server) usuarioRec: description: Representa um usuário simplificado, utilizado na grid de consulta type: object required: – idUsuario – nome – nomeCompleto – email – tipoAutenticacaoLabel properties: idUsuario: type: string description: Identificador do usuário nome: type: string description: Nome do usuário nomeCompleto: type: string description: Nome completo do usuário email: type: string description: Endereço de email do usuário tipoAutenticacaoLabel: type: string allOf: – #/definitions/authType description: Tipo de autenticação usuarioCompletoRec: description: Representa um usuário completo type: object required: – idUsuario – nome – nomeCompleto – email – bloqueado – papeis – admin – tipoAutenticacao – permitidoAlterarSenha properties: idUsuario: type: string description: Id do usuário nome: type: string description: Nome (username) do usuário nomeCompleto: type: string description: Nome completo do usuário email: type: string description: Contém o endereço de email do usuário descricao: type: string description: Descrição do usuário (valor opcional) bloqueado: type: boolean description: Indica se o usuário está bloqueado papeis: type: array items: type: object allOf: #/definitions/papelRec minimum: 1 description: Todos os papéis que o usuário possui propriedades: type: array items: type: object allOf: #/definitions/propriedadeRec description: Todas as propriedades que o usuário possui admin: type: boolean description: Indica se o usuário é um admin de tenant tipoAutenticacao: type: integer format: int64 description: Tipo de autenticação utilizada pelo tenant deste usuário permitidoAlterarSenha: type: boolean description: Indica se o usuário pode alterar a sua senha. É possível alterar a senha quando o tipo de autenticação do tenant é G7 ou quando é G5 e o tenant está configurado para permitir alterar a senha pela G7. localidade: type: string description: localidade do usuário trocaSenha: type: boolean description: Indica se o usuário precisa trocar de senha no próximo logon Para o usuário admin do tenant essa propriedade não é retornada 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 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 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 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 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 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 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 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 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 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 grupoCompletoRec: description: Representa um grupo e suas propriedades type: object required: – idGrupo – nomeGrupo – descricaoGrupo – emailGrupo – usuarios – filtros properties: idGrupo: type: string description: Identificador do grupo nomeGrupo: type: string description: Nome do grupo descricaoGrupo: type: string description: Descrição do grupo emailGrupo: type: string description: Email do grupo usuarios: type: object allOf: #/definitions/usuariosPaginationRec description: Lista com os usuários que este grupo possui filtros: type: array items: type: object allOf: #/definitions/dominioSimplificadoRec minimum: 1 description: Lista com os domínios dos filtros que este grupo possui. O conteúdo dos domínios é obtido sob demanda. usuarioGrupoRec: description: Representa um usuário, para a tela de grupos type: object required: – idUsuario – nomeUsuario properties: idUsuario: type: string description: Identificador do usuário nomeUsuario: type: string description: Nome do usuário notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment