Usuarios

data_sync

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

2.0info: 20.3.0 data_sync description: Provides primitives to integrate G5 users. x-senior-domain: usuarios x-senior-domain-path: usuarios x-senior-service-path: data_sync 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: /data_sync/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 /data_sync/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 /data_sync/actions/replicateUsersAndGroups: post: description: Replicate Users and Groups from G5 to Senior X. If an exception happens the already processed items are rolled back from the platform and an error message is returned, but these users remain on the identity server. In order to avoid discrepancies a new attempt must be made so that users are registered in the platform, leaving them synchronized with the identity server tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – table – items properties: table: type: string description: Table that will be replicated items: type: array items: type: object allOf: #/definitions/userReplicationItem minimum: 1 description: Items of replication responses: 200: description: Ok schema: type: object required: – status – message properties: status: type: string description: Result status of replication, that can be: SUCCESS or ERROR message: type: string description: Details of the result default: description: Error response schema: #/definitions/genericError /data_sync/actions/enableG5UsersSync: post: description: Registers all tables required to synchronize G5 users to the database. An user notification is sent upon completion, with either success or failure of the operation. tags: – Actions x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: If the request could be made will return true, but further info will be sent in a user notification default: description: Error response schema: #/definitions/genericError /data_sync/signals/loadTableData: post: description: Informs this service that new data is available to this domain. This must be used to initial loads of large chunks of data. The data is read from the corresponding repository as a CSV file and inserted in the domain database. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – table – columns – bucket – key properties: table: type: string description: name of the table being populated columns: type: array items: type: string minimum: 1 description: the columns the data is organized into bucket: type: string description: name of the bucket where the file is key: type: string description: the resource key to locate the file inside the bucket responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /data_sync/signals/initialLoadG5: post: description: Prepares and load the G5 users in the users database, then they will be able to do login and use the functionalities. A event will be send (success or fail) in the end of process. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError definitions: userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT userReplicationItem: description: Data replication item type: object required: – operation – fields properties: operation: type: string description: Operation to be realized: D = delete, I = insert, U = update fields: type: string description: Data fields, depending on table been replicated. Example: {field1 : value1, field2 : value2} handleByName: type: boolean description: Defines if the user will be handled by his name 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