Plataforma (platform)

2.0info: 1.0.1 accesscontrol description: x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: accesscontrol contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /platform/accesscontrolsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /apis/namedUser: post: description: The create request primitive for the namedUser facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/namedUserFacade responses: 200: description: Ok schema: #/definitions/namedUserFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the namedUser facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/namedUserFacade default: description: Error response schema: #/definitions/genericError /apis/namedUser/{id}: get: description: The retrieve request primitive for the namedUser facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/namedUserFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the namedUser facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/resource: post: description: The create request primitive for the resource facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/resourceFacade responses: 200: description: Ok schema: #/definitions/resourceFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the resource facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/resourceFacade default: description: Error response schema: #/definitions/genericError /apis/resource/{id}: get: description: The retrieve request primitive for the resource facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/resourceFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the resource facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/module: post: description: The create request primitive for the module facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/moduleFacade responses: 200: description: Ok schema: #/definitions/moduleFacade default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the module facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/moduleFacade default: description: Error response schema: #/definitions/genericError /apis/module/{id}: put: description: The update request primitive for the module facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/moduleFacade responses: 200: description: Ok schema: #/definitions/moduleFacade default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the module facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/moduleFacade default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the module facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: namedUserFacade: type: object required: – productErpId – metricKey – username properties: id: type: string description: format: uuid productErpId: type: string description: Id do produto no ERP metricKey: type: string description: Métrica do produto no License Server username: type: string description: Nome do usuário moduleFacade: type: object required: – metricKey – productErpId – service – domain – description properties: id: type: string description: format: uuid metricKey: type: string description: Chave da métrica no License Server productErpId: type: string description: Id do produto no erp service: type: string description: Serviço domain: type: string description: Domínio description: type: string description: Descrição do módulo resourceFacade: type: object required: – productErpId – resource – action properties: id: type: string description: format: uuid productErpId: type: string description: Id do produto no erp resource: type: string description: Recurso action: type: string description: Ação do recurso 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