openapi: 3.2.0 info: title: Fenergo Access Layer API version: '1.0' description: 'Operations tagged AccessLayer across 4 of this provider''s published API definitions: fenergo-authorizationcommand-v1-0-openapi.json, fenergo-authorizationquery-v1-0-openapi.json, fenergo-authorizationquery-v2-0-openapi.json, fenergo-authorizationquery-v3-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /authorizationcommand - url: /authorizationquery security: - Bearer: [] tags: - name: AccessLayer paths: /api/access-layer: post: tags: - AccessLayer summary: Create access layer description: 'Creates a new access layer Creates a new access layer. Returns the created access layer id. Required permissions: Following permissions are required: SecurityConfigCreate' operationId: CreateAccessLayer parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Create access layer request content: application/json: schema: $ref: '#/components/schemas/CreateAccessLayerRequestDtoServiceRequest' responses: '202': description: Success. Access layer created content: application/json: schema: $ref: '#/components/schemas/CreateAccessLayerResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - AccessLayer summary: Get access layers description: 'Returns all existing access layers. Required permissions: Following permissions are required: SecurityConfigAccess' operationId: GetAllAccessLayers parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list of access layers is returned content: application/json: schema: $ref: '#/components/schemas/AccessLayerDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT deprecated: true servers: - url: /authorizationcommand /api/access-layer/{id}: put: tags: - AccessLayer summary: Update access layer description: 'Updates access layer Required permissions: Following permissions are required: SecurityConfigEdit' operationId: UpdateAccessLayer parameters: - name: id in: path description: Access layer id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Update access layer request content: application/json: schema: $ref: '#/components/schemas/UpdateAccessLayerRequestDtoServiceRequest' responses: '202': description: Success. Access layer updated content: application/json: schema: $ref: '#/components/schemas/UpdateAccessLayerResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Access layer with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - AccessLayer summary: Delete access layer description: 'Deletes access layer Required permissions: Following permissions are required: SecurityConfigDelete' operationId: DeleteAccessLayer parameters: - name: id in: path description: Access layer id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. Access layer deleted '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Access layer with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - AccessLayer summary: Get access layer by id description: 'Returns the access layer for a given id. Required permissions: Following permissions are required: SecurityConfigAccess' operationId: GetAccessLayer parameters: - name: id in: path description: Access layer id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Access layer is returned content: application/json: schema: $ref: '#/components/schemas/AccessLayerDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Access layer with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /authorizationcommand /api/access-layer/{id}/user/{userId}: put: tags: - AccessLayer summary: Assign user to the access layer description: 'Adds user to an existing access layer. Required permissions: Following permissions are required: UserAdministration' operationId: AssignUserToAccessLayer parameters: - name: id in: path description: Access layer Id required: true schema: type: string format: uuid - name: userId in: path description: User Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. User added to the access layer '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Access layer with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT delete: tags: - AccessLayer summary: Unassign user from the access layer description: 'Removes user from an existing access layer. Required permissions: Following permissions are required: UserAdministration' operationId: UnassignUserFromAccessLayer parameters: - name: id in: path description: Access layer Id required: true schema: type: string format: uuid - name: userId in: path description: User Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Success. User removed from the access layer '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Access layer with given id does not exist type: Error errorCode: Error Code '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /authorizationcommand /api/access-layer/users/{userId}/batch: put: tags: - AccessLayer summary: Batch update user access layers description: 'Assigns user to the access layer(s) in the request if currently is not part of it(them). Removes user from the access layer(s) that is(are) not part of the request, but user has it(them) assigned. Required permissions: Following permissions are required: UserAdministration' operationId: BatchUpdateUserAccessLayers parameters: - name: userId in: path description: User Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: The request containing id's of users that should have the access layer assigned content: application/json: schema: $ref: '#/components/schemas/BatchUpdateUserAccessLayersRequestDtoServiceRequest' responses: '202': description: Success. User access layers updated '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Access layer with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /authorizationcommand /api/access-layer/configuration: put: tags: - AccessLayer summary: Update access layers-related configuration description: 'Updates access layers-related configuration. Required permissions: Following permissions are required: SecurityConfigEdit' operationId: UpdateAccessLayersConfiguration parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: The request containing new configuration values content: application/json: schema: $ref: '#/components/schemas/UpdateAccessLayersConfigurationRequestDtoServiceRequest' responses: '202': description: Success. Configuration updated '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: There are conflicts that cannot be resolved automatically, get latest and apply your changes type: Error errorCode: CONFLICT '400': description: Bad request. The request has missing/invalid values '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - AccessLayer summary: Get access layers configuration description: Returns access layers-related configuration options. operationId: GetAccessLayersConfiguration parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The configuration options content: application/json: schema: $ref: '#/components/schemas/AccessLayersConfigurationDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /authorizationcommand /api/access-layer/{id}/users: get: tags: - AccessLayer summary: Get users with given access layer assigned description: 'Returns the list of user ids (upper cased) assigned to the access layer. Required permissions: Following permissions are required: SecurityConfigAccess' operationId: GetAccessLayerUsers parameters: - name: id in: path description: Access layer Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list user ids is returned content: application/json: schema: $ref: '#/components/schemas/StringIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /authorizationquery /api/v2/access-layer/{id}: get: tags: - AccessLayer summary: Get access layer by id description: 'Returns the access layer for a given id. Required permissions: Following permissions are required: SecurityConfigAccess' operationId: getApiV2AccessLayerById parameters: - name: id in: path description: Access layer id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Access layer is returned content: application/json: schema: $ref: '#/components/schemas/AccessLayerDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Access layer with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetAccessLayer servers: - url: /authorizationquery /api/v2/access-layer/{id}/users: get: tags: - AccessLayer summary: Get users with given access layer assigned description: 'Returns the list of user ids (upper cased) assigned to the access layer. Required permissions: Following permissions are required: SecurityConfigAccess' operationId: getApiV2AccessLayerByIdUsers parameters: - name: id in: path description: Access layer Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list user ids is returned content: application/json: schema: $ref: '#/components/schemas/StringIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetAccessLayerUsers servers: - url: /authorizationquery /api/v2/access-layer/configuration: get: tags: - AccessLayer summary: Get access layers configuration description: Returns access layers-related configuration options. operationId: getApiV2AccessLayerConfiguration parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The configuration options content: application/json: schema: $ref: '#/components/schemas/AccessLayersConfigurationDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetAccessLayersConfiguration servers: - url: /authorizationquery /api/v2/access-layer: get: tags: - AccessLayer summary: Get access layers description: 'Returns all existing access layers. Required permissions: Following permissions are required: SecurityConfigAccess' operationId: GetAllAccessLayersV2 parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list of access layers is returned content: application/json: schema: $ref: '#/components/schemas/AccessLayerLightDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /authorizationquery /api/v3/access-layer/{id}: get: tags: - AccessLayer summary: Get access layer by id description: 'Returns the access layer for a given id. Required permissions: Following permissions are required: SecurityConfigAccess' operationId: getApiV3AccessLayerById parameters: - name: id in: path description: Access layer id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. Access layer is returned content: application/json: schema: $ref: '#/components/schemas/AccessLayerDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Access layer with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetAccessLayer servers: - url: /authorizationquery /api/v3/access-layer/{id}/users: get: tags: - AccessLayer summary: Get users with given access layer assigned description: 'Returns the list of user ids (upper cased) assigned to the access layer. Required permissions: Following permissions are required: SecurityConfigAccess' operationId: getApiV3AccessLayerByIdUsers parameters: - name: id in: path description: Access layer Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list user ids is returned content: application/json: schema: $ref: '#/components/schemas/StringIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetAccessLayerUsers servers: - url: /authorizationquery /api/v3/access-layer/configuration: get: tags: - AccessLayer summary: Get access layers configuration description: Returns access layers-related configuration options. operationId: getApiV3AccessLayerConfiguration parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The configuration options content: application/json: schema: $ref: '#/components/schemas/AccessLayersConfigurationDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetAccessLayersConfiguration servers: - url: /authorizationquery /api/v3/access-layer: get: tags: - AccessLayer summary: Get paged access layers description: 'Returns all existing access layers. Required permissions: Following permissions are required: SecurityConfigAccess' operationId: GetAccessLayersPaged parameters: - name: PaginationToken in: query description: Pagination token schema: type: - string - 'null' description: Pagination token - name: PageSize in: query description: Page size schema: maximum: 500 minimum: 1 type: integer description: Page size format: int32 example: 30 example: 30 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list of access layers is returned content: application/json: schema: $ref: '#/components/schemas/AccessLayerLightDtoItemsPageServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /authorizationquery components: schemas: UpdateAccessLayersConfigurationRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/UpdateAccessLayersConfigurationRequestDto' additionalProperties: false description: Service request data UpdateAccessLayerRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/UpdateAccessLayerRequestDto' additionalProperties: false description: Service request data CreateAccessLayerResponseDto: type: object properties: id: type: string description: The UiD of created access layer format: uuid example: 1bb44eba-d489-4138-8cfa-eee3d49250c9 additionalProperties: false description: Response DTO representing created access layer BatchUpdateUserAccessLayersRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/BatchUpdateUserAccessLayersRequestDto' additionalProperties: false description: Service request data UpdateAccessLayerResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/UpdateAccessLayerResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data UpdateAccessLayersConfigurationRequestDto: required: - enableDynamicAccessLayers - enableDynamicAccessLayersOnDraftUpdate - enableDynamicAccessLayersOnProduct - enableSensitiveData - populateDefaultAccessLayers type: object properties: populateDefaultAccessLayers: type: boolean description: If set to true default access layers (Enterprise, Global) will be populated automatically when creating a new entity default: false example: true enableDynamicAccessLayers: type: boolean description: If set to true automatic access layer evaluation engine will be enabled default: false example: true enableSensitiveData: type: boolean description: If set to true sensitive data handling will be enabled (fields masked with reveal capability) default: false example: true enableDynamicAccessLayersOnDraftUpdate: type: boolean description: If set to true automatic access layer evaluation engine will be enabled additionally for EntityDraftUpdated default: false example: true enableDynamicAccessLayersOnProduct: type: boolean description: If set to true automatic access layer evaluation engine will be enabled additionally for Products default: false example: true version: type: integer description: "Current version of the access layers-related configuration where the changes needs to be applied. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking" format: int32 default: -1 example: 1 additionalProperties: false AccessLayerTypeDto: enum: - Geographic - BusinessRelated type: string CreateAccessLayerRequestDto: type: object properties: dataKey: type: - string - 'null' description: 'Data key of the access layer The property is immutable' example: PrivateBanking label: type: - string - 'null' description: Label of the access layer example: Private Banking description: type: - string - 'null' description: Description of the access layer example: Business related access layer for entities type: $ref: '#/components/schemas/AccessLayerTypeDto' dataType: $ref: '#/components/schemas/AccessLayerDataTypeDto' users: type: - array - 'null' items: type: string description: List of user ids assigned to the access layer sensitiveDataKind: $ref: '#/components/schemas/SensitiveDataKindDto' additionalProperties: false description: Request DTO representing access layer data to create CreateAccessLayerResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/CreateAccessLayerResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data CreateAccessLayerRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/CreateAccessLayerRequestDto' additionalProperties: false description: Service request data SensitiveDataKindDto: enum: - None - SensitiveData - SensitiveDataDelegate type: string description: Set of possible values for Sensitive Data parameter ObjectServiceResponse: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ValidationErrorModelListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code StringServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data UpdateAccessLayerRequestDto: type: object properties: label: type: - string - 'null' description: Label of the access layer example: Private Banking description: type: - string - 'null' description: Description of the access layer example: Business related access layer for entities type: $ref: '#/components/schemas/AccessLayerTypeDto' dataType: $ref: '#/components/schemas/AccessLayerDataTypeDto' sensitiveDataKind: $ref: '#/components/schemas/SensitiveDataKindDto' version: type: integer description: "Current version of the access layer where the changes needs to be applied. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking" format: int32 default: -1 example: 1 additionalProperties: false description: Request DTO representing access layer data to update ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' description: Name of the property example: data errorMessage: type: - string - 'null' description: User friendly error message example: Data is required attemptedValue: description: Invalid value errorCode: type: - string - 'null' description: Internal error code example: NotNullValidator additionalProperties: false description: Represents the details of validation error AccessLayerDataTypeDto: enum: - Field - Entity - Journey - Document - Search - Product - ProductField type: string BatchUpdateUserAccessLayersRequestDto: type: object properties: accessLayers: type: - array - 'null' items: type: string format: uuid description: List of IDs of access layers that should be assigned to user additionalProperties: false description: Batch update users request data ServiceResponseMessage: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response UpdateAccessLayerResponseDto: type: object properties: version: type: integer description: Version of access layer after update format: int32 example: 1 additionalProperties: false description: Response DTO representing updated access layer AccessLayersConfigurationDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AccessLayersConfigurationDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data AccessLayersConfigurationDto: type: object properties: populateDefaultAccessLayers: type: boolean description: If set to true default access layers (Enterprise, Global) will be populated automatically when creating a new entity example: true enableDynamicAccessLayers: type: boolean description: If set to true automatic access layer evaluation engine will be enabled example: true enableSensitiveData: type: boolean description: If set to true sensitive data handling will be enabled (fields masked with reveal capability) example: true enableDynamicAccessLayersOnDraftUpdate: type: boolean description: If set to true automatic access layer evaluation engine will be enabled additionally for EntityDraftUpdated example: true enableDynamicAccessLayersOnProduct: type: boolean description: If set to true automatic access layer evaluation engine will be enabled additionally for products example: true version: type: integer description: "Current version of the access layers-related configuration where the changes needs to be applied. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking" format: int32 example: 1 additionalProperties: false description: Response DTO representing access layers configuration AccessLayerDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data AccessLayerDataTypeDto_2: enum: - Field - DataGroup - Entity - Journey - Document - Search - Product - ProductField type: string AccessLayerDto: type: object properties: id: type: string description: The UiD of the team format: uuid example: e4ec4810-6386-4610-a605-0d636f393daf name: type: - string - 'null' description: 'Name of the access layer The value is calculated based on dataKey, type and dataType fields' example: Private Banking - Business Related - Search dataKey: type: - string - 'null' description: Data key of the access layer example: PrivateBanking label: type: - string - 'null' description: Label of the access layer example: Private Banking description: type: - string - 'null' description: Description of the access layer example: Business related access layer for entities type: allOf: - $ref: '#/components/schemas/AccessLayerTypeDto' description: Type of the access layer example: Business Related dataType: allOf: - $ref: '#/components/schemas/AccessLayerDataTypeDto_2' description: Data type of the access layer example: Search sensitiveDataKind: allOf: - $ref: '#/components/schemas/SensitiveDataKindDto' description: Value indicating if this access layer should be used to restrict access to Sensitive Data data example: SensitiveDataDelegate users: type: - array - 'null' items: type: string description: List of user ids assigned to the access layer version: type: integer description: Version number for given Entity format: int32 example: 1 additionalProperties: false description: Response DTO representing access layer data StringIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: type: string description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data AccessLayerDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/AccessLayerDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data AccessLayerLightDto: type: object properties: id: type: string description: The UiD of the team format: uuid example: e4ec4810-6386-4610-a605-0d636f393daf name: type: - string - 'null' description: 'Name of the access layer The value is calculated based on dataKey, type and dataType fields' example: Private Banking - Business Related - Search dataKey: type: - string - 'null' description: Data key of the access layer example: PrivateBanking label: type: - string - 'null' description: Label of the access layer example: Private Banking description: type: - string - 'null' description: Description of the access layer example: Business related access layer for entities usersCount: type: integer description: Number of users assigned to access layer format: int32 example: 10 type: allOf: - $ref: '#/components/schemas/AccessLayerTypeDto' description: Type of the access layer example: Business Related dataType: allOf: - $ref: '#/components/schemas/AccessLayerDataTypeDto_3' description: Data type of the access layer example: Search sensitiveDataKind: allOf: - $ref: '#/components/schemas/SensitiveDataKindDto' description: Value indicating if this access layer should be used to restrict access to Sensitive Data data example: SensitiveDataDelegate version: type: integer description: Version number for given Entity format: int32 example: 1 additionalProperties: false description: Response DTO representing access layer data AccessLayerDataTypeDto_3: enum: - Field - DataGroup - Entity - Journey - Document - Search - Product - ProductField type: string AccessLayerLightDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/AccessLayerLightDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data AccessLayerDto_2: type: object properties: id: type: string description: The UiD of the team format: uuid example: e4ec4810-6386-4610-a605-0d636f393daf name: type: - string - 'null' description: 'Name of the access layer The value is calculated based on dataKey, type and dataType fields' example: Private Banking - Business Related - Search dataKey: type: - string - 'null' description: Data key of the access layer example: PrivateBanking label: type: - string - 'null' description: Label of the access layer example: Private Banking description: type: - string - 'null' description: Description of the access layer example: Business related access layer for entities type: allOf: - $ref: '#/components/schemas/AccessLayerTypeDto' description: Type of the access layer example: Business Related dataType: allOf: - $ref: '#/components/schemas/AccessLayerDataTypeDto_3' description: Data type of the access layer example: Search sensitiveDataKind: allOf: - $ref: '#/components/schemas/SensitiveDataKindDto' description: Value indicating if this access layer should be used to restrict access to Sensitive Data data example: SensitiveDataDelegate users: type: - array - 'null' items: type: string description: List of user ids assigned to the access layer version: type: integer description: Version number for given Entity format: int32 example: 1 additionalProperties: false description: Response DTO representing access layer data AccessLayerLightDto_2: type: object properties: id: type: string description: The UiD of the team format: uuid example: e4ec4810-6386-4610-a605-0d636f393daf name: type: - string - 'null' description: 'Name of the access layer The value is calculated based on dataKey, type and dataType fields' example: Private Banking - Business Related - Search dataKey: type: - string - 'null' description: Data key of the access layer example: PrivateBanking label: type: - string - 'null' description: Label of the access layer example: Private Banking description: type: - string - 'null' description: Description of the access layer example: Business related access layer for entities usersCount: type: integer description: Number of users assigned to access layer format: int32 example: 10 type: allOf: - $ref: '#/components/schemas/AccessLayerTypeDto' description: Type of the access layer example: Business Related dataType: allOf: - $ref: '#/components/schemas/AccessLayerDataTypeDto_4' description: Data type of the access layer example: Search sensitiveDataKind: allOf: - $ref: '#/components/schemas/SensitiveDataKindDto' description: Value indicating if this access layer should be used to restrict access to Sensitive Data data example: SensitiveDataDelegate version: type: integer description: Version number for given Entity format: int32 example: 1 additionalProperties: false description: Response DTO representing access layer data AccessLayerDataTypeDto_4: enum: - Field - DataGroup - Entity - Journey - Document - Search - Product - ProductField type: string AccessLayerDto_3: type: object properties: id: type: string description: The UiD of the team format: uuid example: e4ec4810-6386-4610-a605-0d636f393daf name: type: - string - 'null' description: 'Name of the access layer The value is calculated based on dataKey, type and dataType fields' example: Private Banking - Business Related - Search dataKey: type: - string - 'null' description: Data key of the access layer example: PrivateBanking label: type: - string - 'null' description: Label of the access layer example: Private Banking description: type: - string - 'null' description: Description of the access layer example: Business related access layer for entities type: allOf: - $ref: '#/components/schemas/AccessLayerTypeDto' description: Type of the access layer example: Business Related dataType: allOf: - $ref: '#/components/schemas/AccessLayerDataTypeDto_4' description: Data type of the access layer example: Search sensitiveDataKind: allOf: - $ref: '#/components/schemas/SensitiveDataKindDto' description: Value indicating if this access layer should be used to restrict access to Sensitive Data data example: SensitiveDataDelegate users: type: - array - 'null' items: type: string description: List of user ids assigned to the access layer version: type: integer description: Version number for given Entity format: int32 example: 1 additionalProperties: false description: Response DTO representing access layer data AccessLayerLightDtoItemsPageServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/AccessLayerLightDtoItemsPage' description: Query Result Page messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data AccessLayerLightDtoItemsPage: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/AccessLayerLightDto_2' description: The items result set paginationToken: type: - string - 'null' description: The token for retrieving the next page of results additionalProperties: false description: Query Result Page securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-authorizationcommand-v1-0-openapi.json - fenergo-authorizationquery-v1-0-openapi.json - fenergo-authorizationquery-v2-0-openapi.json - fenergo-authorizationquery-v3-0-openapi.json