2.0info: 32.1.2 web_interface x-senior-domain: usuarios x-senior-domain-path: usuarios x-senior-service-path: web_interface 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/usuariossecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /web_interface/queries/listaTodosUsuarios: post: description: API DEPRECIADA: Use user/listUsers (+ authorization/getUserRoles if needed) instead | DATA: 2021-01-22 | Retorna uma lista com todos os usuarios, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries deprecated : true 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Use user/listUsers (+ authorization/getUserRoles if needed) instead | DATA: 2021-01-22 | Retorna uma lista com todos os usuarios, respeitando a paginação e a ordenação passadas como parâmetro tags: – Queries deprecated : true 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 401: description: Invalid Credentials 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 401: description: Invalid Credentials 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 401: description: Invalid Credentials 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: 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 /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: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /web_interface/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: 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 healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN 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 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 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 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status 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