2.0info: 1.2.0 Auditoria de permissões do Authorization description: Responsável pela geração de auditoria das permissões do authorization x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: audit_authorization contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /audit_authorization/queries/healthcheck: post: description: Verifica se o serviço está funcionando tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Itens verificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o serviço está funcionando tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Itens verificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /audit_authorization/queries/listResources: post: description: Lista os recursos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Número da página. Se não informado, o valor será 0 default: 0 size: type: integer format: int64 description: Total de registros por página, se não for informado o valor será 10 default: 10 searchValue: type: string description: Filtro utilizado para localizar um ou mais recursos de forma rápida includeMaster: type: boolean description: Incluir os recursos do tenant master default: false role: type: string description: Filtrar os recursos vinculados a um papel específico responses: 200: description: Ok schema: type: object required: – resources – listInformation properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Lista de recursos listInformation: type: object allOf: – #/definitions/listInformation description: Informação sobre o resultado da listagem 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Lista os recursos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Número da página. Se não informado, o valor será 0 in: query type: integer format: int64 – name: size description: Total de registros por página, se não for informado o valor será 10 in: query type: integer format: int64 – name: searchValue description: Filtro utilizado para localizar um ou mais recursos de forma rápida in: query type: string – name: includeMaster description: Incluir os recursos do tenant master in: query type: boolean – name: role description: Filtrar os recursos vinculados a um papel específico in: query type: string responses: 200: description: Ok schema: type: object required: – resources – listInformation properties: resources: type: array items: type: object allOf: – #/definitions/resource minimum: 1 description: Lista de recursos listInformation: type: object allOf: – #/definitions/listInformation description: Informação sobre o resultado da listagem 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /audit_authorization/queries/listRoles: post: description: Lista os papeis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Número da página. Se não informado, o valor será 0 default: 0 size: type: integer format: int64 description: Total de registros por página, se não for informado o valor será 10 default: 10 searchValue: type: string description: Filtro utilizado para localizar um ou mais papel de forma rápida responses: 200: description: Ok schema: type: object required: – roles – listInformation properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Lista de papeis listInformation: type: object allOf: – #/definitions/listInformation description: Informação sobre o resultado da listagem 401: description: Usuário ou senha inválidos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Lista os papeis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Número da página. Se não informado, o valor será 0 in: query type: integer format: int64 – name: size description: Total de registros por página, se não for informado o valor será 10 in: query type: integer format: int64 – name: searchValue description: Filtro utilizado para localizar um ou mais papel de forma rápida in: query type: string responses: 200: description: Ok schema: type: object required: – roles – listInformation properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Lista de papeis listInformation: type: object allOf: – #/definitions/listInformation description: Informação sobre o resultado da listagem 401: description: Usuário ou senha inválidos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /audit_authorization/queries/listRolesByUser: post: description: Lista os papeis do usuário informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – username properties: username: type: string description: Nome do usuário responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Lista de papeis 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Lista os papeis do usuário informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: username description: Nome do usuário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Lista de papeis 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /audit_authorization/queries/listUsers: post: description: Lista os usuários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Número da página. Se não informado, o valor será 0 default: 0 size: type: integer format: int64 description: Total de registros por página, se não for informado o valor será 10 default: 10 role: type: string description: Se informado retorna apenas o usuários vinculados ao papel searchValue: type: string description: Filtro utilizado para localizar um ou mais usuários de forma rápida includeBlocked: type: boolean description: Incluir usuários bloqueados, valor padrão falso default: false responses: 200: description: Ok schema: type: object required: – users – listInformation properties: users: type: array items: type: object allOf: – #/definitions/user minimum: 1 description: Lista de usuários listInformation: type: object allOf: – #/definitions/listInformation description: Informação sobre a listagem do resultado 401: description: Usuário ou senha inválidos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Lista os usuários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Número da página. Se não informado, o valor será 0 in: query type: integer format: int64 – name: size description: Total de registros por página, se não for informado o valor será 10 in: query type: integer format: int64 – name: role description: Se informado retorna apenas o usuários vinculados ao papel in: query type: string – name: searchValue description: Filtro utilizado para localizar um ou mais usuários de forma rápida in: query type: string – name: includeBlocked description: Incluir usuários bloqueados, valor padrão falso in: query type: boolean responses: 200: description: Ok schema: type: object required: – users – listInformation properties: users: type: array items: type: object allOf: – #/definitions/user minimum: 1 description: Lista de usuários listInformation: type: object allOf: – #/definitions/listInformation description: Informação sobre a listagem do resultado 401: description: Usuário ou senha inválidos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /audit_authorization/queries/listRolesByUri: post: description: Lista os papeis vinculados a um recurso tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – uri properties: page: type: integer format: int64 description: Número da página. Se não informado, o valor será 0 default: 0 size: type: integer format: int64 description: Total de registros por página, se não for informado o valor será 10 default: 10 uri: type: string description: Informe o recurso para encontrar os papeis vinculados a ele searchValue: type: string description: Filtro utlizado para localizar um ou mais papel vinculado ao recurso informado responses: 200: description: Ok schema: type: object required: – roles – listInformation properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Lista de papeis listInformation: type: object allOf: – #/definitions/listInformation description: Informação sobre a listagem do resultado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Lista os papeis vinculados a um recurso tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Número da página. Se não informado, o valor será 0 in: query type: integer format: int64 – name: size description: Total de registros por página, se não for informado o valor será 10 in: query type: integer format: int64 – name: uri description: Informe o recurso para encontrar os papeis vinculados a ele in: query required: true type: string – name: searchValue description: Filtro utlizado para localizar um ou mais papel vinculado ao recurso informado in: query type: string responses: 200: description: Ok schema: type: object required: – roles – listInformation properties: roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Lista de papeis listInformation: type: object allOf: – #/definitions/listInformation description: Informação sobre a listagem do resultado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /audit_authorization/queries/exportRolesReport: post: description: Exporta o relatório de papéis, enviando para o solicitador uma notificação com o link para download quando o processo finalizar. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – roles – format properties: roles: type: array items: type: string minimum: 1 description: Nome dos papéis que serão inclusos no relatório format: type: string allOf: – #/definitions/reportFormat description: Formato que será gerado o relatório responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada 404: description: Requisição não encontrada default: description: Error response schema: #/definitions/genericError /audit_authorization/queries/exportUsersReport: post: description: Exporta o relatório de usuários, enviando para o solicitador uma notificação com o link para download quando o processo finalizar. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – users – format properties: users: type: array items: type: string minimum: 1 description: Nome dos usuários que serão inclusos no relatório format: type: string allOf: – #/definitions/reportFormat description: Formato que será gerado o relatório reportType: type: string allOf: – #/definitions/reportType description: Tipo do relatório PDF que deve ser exportado responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada 404: description: Requisição não encontrada default: description: Error response schema: #/definitions/genericError /audit_authorization/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /audit_authorization/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthCheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN reportFormat: description: Tipo de formato do relatório type: string enum: – PDF – CSV reportType: description: Tipo do relatório PDF que deve ser exportado type: string enum: – SIMPLIFIED – COMPLETE userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT checkDTO: description: Itens verificados no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthCheckStatus description: Status resource: description: Informações do recurso type: object required: – resourceName – uri – locked – actions properties: resourceName: type: string description: Nome descritivo do recurso uri: type: string description: Uri do recursos locked: type: boolean description: Indica se o recurso está bloqueado actions: type: array items: type: string minimum: 1 description: Ações que o recurso possui role: description: Informações do papel type: object required: – name – description properties: name: type: string description: Nome do papel description: type: string description: Descrição do papel user: description: Usuário type: object required: – username – fullName – blocked properties: username: type: string description: Login do usuário fullName: type: string description: Nome completo do usuário blocked: type: boolean description: Informa se o usuário está bloqueado listInformation: description: Informação sobre o resultado da listagem type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Total de registros totalPages: type: integer format: int64 description: Total de páginas 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