openapi: 3.0.1 info: description: 'Consumer-to-Extole integration endpoints: consumer event submission, zone rendering, profile management, and SDK-backing operations for browser and native app environments.' title: Integration API - Consumer to Extole Audiences Security Keys API version: '1.0' servers: - description: Production url: https://{brand}.extole.io variables: brand: default: yourcompany description: Your Extole client subdomain (e.g. 'mycompany' for mycompany.extole.io) security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Security Keys paths: /v2/settings/security/keys/jwt/{key_id}/verify-jwt: post: deprecated: true description: Deprecated. Verifies a JWT signature using the key material stored on the client key identified by `key_id`. The JWT `kid` header must match the key `partner_key_id`. operationId: verifyJwtClientKey parameters: - in: path name: key_id required: true schema: type: string requestBody: content: application/json: example: jwt: jwt schema: $ref: '#/components/schemas/JwtClientKeyVerifyJwtRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/JwtClientKeyVerifyJwtResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' client_key_not_found: $ref: '#/components/examples/client_key_not_found' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' jwt_missing: $ref: '#/components/examples/jwt_missing' missing_request_body: $ref: '#/components/examples/missing_request_body' pgp_extole_client_key_not_found: $ref: '#/components/examples/pgp_extole_client_key_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Verify JWT client key tags: - Security Keys x-extole-bundle: management-expert x-extole-visibility: expert /v2/settings/security/keys: get: description: Returns active (non-archived) security keys for the client. Keys store credentials and cryptographic material used by integrations, campaign components, SFTP file transfer, and outbound webhooks. Pass one or more `tags` query values; a key is returned only when it includes every supplied tag. Use `GET /v2/settings/security/keys/built` for the fully evaluated runtime form. operationId: listClientKeys parameters: - in: query name: tags schema: items: type: string type: array uniqueItems: true responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ClientKeyResponse' type: array description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: List client keys tags: - Security Keys x-extole-bundle: management x-extole-visibility: visible post: description: Creates a client key from a JSON request body. Supported variants include OAuth integrations, inline PGP or SSH key material, JWT signing keys, webhook secrets, and generic password or HTTP basic credentials. Set `algorithm` to select the polymorphic request and response schema. Set `type` to classify what the key is used for. operationId: createClientKey requestBody: content: application/json: example: algorithm: A128KW component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name description: description key: key name: name partner_key_id: partner_key_id tags: - tag type: JWT schema: $ref: '#/components/schemas/StringBasedClientKeyCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClientKeyResponse' description: Successful response '400': content: application/json: examples: authorization_url_invalid: $ref: '#/components/examples/authorization_url_invalid' authorization_url_invalid_uri: $ref: '#/components/examples/authorization_url_invalid_uri' authorization_url_too_long: $ref: '#/components/examples/authorization_url_too_long' binding_error: $ref: '#/components/examples/binding_error' campaign_component_absolute_name_missing: $ref: '#/components/examples/campaign_component_absolute_name_missing' campaign_component_description_out_of_range: $ref: '#/components/examples/campaign_component_description_out_of_range' campaign_component_display_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_display_name_contains_illegal_character' campaign_component_display_name_out_of_range: $ref: '#/components/examples/campaign_component_display_name_out_of_range' campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_name_contains_illegal_character' campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' circular_component_reference: $ref: '#/components/examples/circular_component_reference' client_key_build_failed: $ref: '#/components/examples/client_key_build_failed' client_key_duplicate_partner_key_id: $ref: '#/components/examples/client_key_duplicate_partner_key_id' client_key_invalid: $ref: '#/components/examples/client_key_invalid' client_key_invalid_description: $ref: '#/components/examples/client_key_invalid_description' client_key_invalid_name: $ref: '#/components/examples/client_key_invalid_name' client_key_invalid_partner_key_id: $ref: '#/components/examples/client_key_invalid_partner_key_id' client_key_invalid_tag: $ref: '#/components/examples/client_key_invalid_tag' client_key_missing: $ref: '#/components/examples/client_key_missing' client_key_missing_algorithm: $ref: '#/components/examples/client_key_missing_algorithm' client_key_missing_name: $ref: '#/components/examples/client_key_missing_name' client_key_missing_type: $ref: '#/components/examples/client_key_missing_type' client_key_not_found: $ref: '#/components/examples/client_key_not_found' client_key_too_long: $ref: '#/components/examples/client_key_too_long' client_key_too_short: $ref: '#/components/examples/client_key_too_short' client_key_unsupported_type: $ref: '#/components/examples/client_key_unsupported_type' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' external_element_in_use: $ref: '#/components/examples/external_element_in_use' external_element_is_referenced_by_active_configuration: $ref: '#/components/examples/external_element_is_referenced_by_active_configuration' external_elements_cannot_have_multiple_references: $ref: '#/components/examples/external_elements_cannot_have_multiple_references' invalid_account_id: $ref: '#/components/examples/invalid_account_id' invalid_component_installed_into_socket: $ref: '#/components/examples/invalid_component_installed_into_socket' invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: '#/components/examples/invalid_component_reference_socket_name' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_app_key: $ref: '#/components/examples/missing_app_key' missing_authorization_url: $ref: '#/components/examples/missing_authorization_url' missing_lead_perfection_client_id: $ref: '#/components/examples/missing_lead_perfection_client_id' missing_oauth_client_id: $ref: '#/components/examples/missing_oauth_client_id' missing_password: $ref: '#/components/examples/missing_password' missing_request_body: $ref: '#/components/examples/missing_request_body' missing_username: $ref: '#/components/examples/missing_username' oauth_client_id_too_long: $ref: '#/components/examples/oauth_client_id_too_long' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' pgp_extole_client_key_not_found: $ref: '#/components/examples/pgp_extole_client_key_not_found' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' scope_too_long: $ref: '#/components/examples/scope_too_long' self_component_reference: $ref: '#/components/examples/self_component_reference' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Create client key tags: - Security Keys x-extole-bundle: management x-extole-visibility: visible /v2/settings/security/keys/built: get: description: Returns the built form of each matching active client key with evaluatable fields resolved for the current client context. Supports the same `tags` filter as `GET /v2/settings/security/keys`. operationId: listBuiltClientKeys parameters: - in: query name: tags schema: items: type: string type: array uniqueItems: true responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/BuiltClientKeyResponse' type: array description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: List built client keys tags: - Security Keys x-extole-bundle: management x-extole-visibility: visible /v2/settings/security/keys/{key_id}/delete: post: description: Permanently deletes an archived client key. The key must not be referenced by campaign components or other platform resources. operationId: deleteClientKey parameters: - in: path name: key_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClientKeyResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' client_key_associated_with_entity: $ref: '#/components/examples/client_key_associated_with_entity' client_key_not_found: $ref: '#/components/examples/client_key_not_found' external_element_in_use: $ref: '#/components/examples/external_element_in_use' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' pgp_extole_client_key_not_found: $ref: '#/components/examples/pgp_extole_client_key_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Delete client key tags: - Security Keys x-extole-bundle: management x-extole-visibility: visible /v2/settings/security/keys/{key_id}/unarchive: post: description: Restores a previously archived client key so it can be used again. operationId: unarchiveClientKey parameters: - in: path name: key_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClientKeyResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' client_key_associated_with_entity: $ref: '#/components/examples/client_key_associated_with_entity' client_key_not_found: $ref: '#/components/examples/client_key_not_found' external_element_in_use: $ref: '#/components/examples/external_element_in_use' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' pgp_extole_client_key_not_found: $ref: '#/components/examples/pgp_extole_client_key_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Unarchive client key tags: - Security Keys x-extole-bundle: management x-extole-visibility: visible /v2/settings/security/keys/{key_id}: put: description: Updates an existing client key identified by `key_id`. Only fields present in the request body are changed. operationId: updateClientKey parameters: - in: path name: key_id required: true schema: type: string requestBody: content: application/json: example: algorithm: A128KW component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name description: description key: key name: name partner_key_id: partner_key_id schema: $ref: '#/components/schemas/ClientKeyUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClientKeyResponse' description: Successful response '400': content: application/json: examples: authorization_url_invalid: $ref: '#/components/examples/authorization_url_invalid' authorization_url_invalid_uri: $ref: '#/components/examples/authorization_url_invalid_uri' authorization_url_too_long: $ref: '#/components/examples/authorization_url_too_long' binding_error: $ref: '#/components/examples/binding_error' campaign_component_absolute_name_missing: $ref: '#/components/examples/campaign_component_absolute_name_missing' campaign_component_description_out_of_range: $ref: '#/components/examples/campaign_component_description_out_of_range' campaign_component_display_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_display_name_contains_illegal_character' campaign_component_display_name_out_of_range: $ref: '#/components/examples/campaign_component_display_name_out_of_range' campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: '#/components/examples/campaign_component_name_contains_illegal_character' campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_type_validation_failed: $ref: '#/components/examples/campaign_component_type_validation_failed' circular_component_reference: $ref: '#/components/examples/circular_component_reference' client_key_build_failed: $ref: '#/components/examples/client_key_build_failed' client_key_duplicate_partner_key_id: $ref: '#/components/examples/client_key_duplicate_partner_key_id' client_key_invalid: $ref: '#/components/examples/client_key_invalid' client_key_invalid_description: $ref: '#/components/examples/client_key_invalid_description' client_key_invalid_name: $ref: '#/components/examples/client_key_invalid_name' client_key_invalid_partner_key_id: $ref: '#/components/examples/client_key_invalid_partner_key_id' client_key_invalid_tag: $ref: '#/components/examples/client_key_invalid_tag' client_key_missing: $ref: '#/components/examples/client_key_missing' client_key_missing_algorithm: $ref: '#/components/examples/client_key_missing_algorithm' client_key_missing_name: $ref: '#/components/examples/client_key_missing_name' client_key_missing_type: $ref: '#/components/examples/client_key_missing_type' client_key_not_found: $ref: '#/components/examples/client_key_not_found' client_key_too_long: $ref: '#/components/examples/client_key_too_long' client_key_too_short: $ref: '#/components/examples/client_key_too_short' client_key_unsupported_type: $ref: '#/components/examples/client_key_unsupported_type' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' external_element_in_use: $ref: '#/components/examples/external_element_in_use' external_element_is_referenced_by_active_configuration: $ref: '#/components/examples/external_element_is_referenced_by_active_configuration' external_elements_cannot_have_multiple_references: $ref: '#/components/examples/external_elements_cannot_have_multiple_references' invalid_account_id: $ref: '#/components/examples/invalid_account_id' invalid_component_installed_into_socket: $ref: '#/components/examples/invalid_component_installed_into_socket' invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: '#/components/examples/invalid_component_reference_socket_name' invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_authorization_url: $ref: '#/components/examples/missing_authorization_url' missing_oauth_client_id: $ref: '#/components/examples/missing_oauth_client_id' missing_request_body: $ref: '#/components/examples/missing_request_body' oauth_client_id_too_long: $ref: '#/components/examples/oauth_client_id_too_long' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' pgp_extole_client_key_not_found: $ref: '#/components/examples/pgp_extole_client_key_not_found' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' scope_too_long: $ref: '#/components/examples/scope_too_long' self_component_reference: $ref: '#/components/examples/self_component_reference' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Update client key tags: - Security Keys x-extole-bundle: management x-extole-visibility: visible delete: description: Archives a client key so it no longer appears in list results or can be selected for new use. The key record is retained and can be restored with `POST /v2/settings/security/keys/{key_id}/unarchive`. Fails when the key is still referenced by campaign components or other platform resources. operationId: archiveClientKey parameters: - in: path name: key_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClientKeyResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' client_key_associated_with_entity: $ref: '#/components/examples/client_key_associated_with_entity' client_key_not_found: $ref: '#/components/examples/client_key_not_found' external_element_in_use: $ref: '#/components/examples/external_element_in_use' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' pgp_extole_client_key_not_found: $ref: '#/components/examples/pgp_extole_client_key_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests summary: Archive client key tags: - Security Keys x-extole-bundle: management x-extole-visibility: visible components: schemas: OAuthListrakClientKeyCreateRequest: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - OAUTH_LISTRAK type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthListrakClientKeyCreateRequest' oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string scope: description: Optional space-delimited OAuth scopes to request during authorization. nullable: true type: string type: object required: - algorithm - authorization_url - description - key - name - oauth_client_id - partner_key_id - scope - type type: object GenericClientKeyCreateRequestAsEs256Public: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - ES256_PUBLIC type: string required: - algorithm - description - key - name - partner_key_id - type type: object GenericClientKeyResponseAsHs256: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - HS256 type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object ClientKeyUpdateRequestBase: properties: algorithm: description: Cryptographic or integration algorithm. Discriminator for polymorphic create, update, and response schemas. enum: - A128KW - A192KW - A256KW - ES256_PRIVATE - ES256_PUBLIC - ES384_PRIVATE - ES384_PUBLIC - ES512_PRIVATE - ES512_PUBLIC - GENERIC - HS256 - HS384 - HS512 - HTTP_BASIC - OAUTH - OAUTH_GENERIC - OAUTH_LEAD_PERFECTION - OAUTH_LISTRAK - OAUTH_OPTIMOVE - OAUTH_SALESFORCE - OAUTH_SFDC - OAUTH_SFDC_PASSWORD - PASSWORD - PS256_PRIVATE - PS256_PUBLIC - PS384_PRIVATE - PS384_PUBLIC - PS512_PRIVATE - PS512_PUBLIC - RS256_PRIVATE - RS256_PUBLIC - RS384_PRIVATE - RS384_PUBLIC - RS512_PRIVATE - RS512_PUBLIC - RSA - RSA_OAEP_256_PRIVATE - RSA_OAEP_256_PUBLIC - RSA_OAEP_384_PRIVATE - RSA_OAEP_384_PUBLIC - RSA_OAEP_512_PRIVATE - RSA_OAEP_512_PUBLIC - SSL_PKCS_12 type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array description: $ref: '#/components/schemas/DescriptionInClientKeyUpdateRequestBase' name: $ref: '#/components/schemas/NameInClientKeyUpdateRequestBase' partner_key_id: description: New external key identifier (for example JWT kid). Omit to leave unchanged. type: string type: object AuthorizationUrlInOAuthListrakClientKeyUpdateRequest: description: New build-time expression for the authorization endpoint URL. Omit to leave unchanged. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInGenericClientKeyUpdateRequestAsPassword: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyResponseAsA192kw: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - A192KW type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyResponseAsPs256Private: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - PS256_PRIVATE type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object OAuthOptimoveClientKeyCreateRequest: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - OAUTH_OPTIMOVE type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthOptimoveClientKeyCreateRequest' oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string scope: description: Optional space-delimited OAuth scopes to request during authorization. nullable: true type: string type: object required: - algorithm - authorization_url - description - key - name - oauth_client_id - partner_key_id - scope - type type: object DescriptionInGenericClientKeyUpdateRequestAsA128kw: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyUpdateRequestAsEs384Public: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - ES384_PUBLIC type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsEs384Public' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object GenericClientKeyCreateRequestAsPs384Private: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - PS384_PRIVATE type: string required: - algorithm - description - key - name - partner_key_id - type type: object DescriptionInOAuthSalesforceClientKeyUpdateRequest: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyCreateRequestAsPs256Private: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - PS256_PRIVATE type: string required: - algorithm - description - key - name - partner_key_id - type type: object GenericClientKeyResponseAsPs256Public: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - PS256_PUBLIC type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyResponseAsEs384Public: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - ES384_PUBLIC type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object OAuthSalesforceClientKeyCreateRequest: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: account_id: format: int32 type: integer algorithm: enum: - OAUTH_SALESFORCE type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthSalesforceClientKeyCreateRequest' oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string scope: description: Optional space-delimited OAuth scopes to request during authorization. nullable: true type: string type: object required: - account_id - algorithm - authorization_url - description - key - name - oauth_client_id - partner_key_id - scope - type type: object BuiltGenericClientKeyResponseAsA192kw: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - A192KW type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyUpdateRequestAsEs384Private: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - ES384_PRIVATE type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsEs384Private' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object GenericClientKeyCreateRequestAsEs384Public: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - ES384_PUBLIC type: string required: - algorithm - description - key - name - partner_key_id - type type: object DescriptionInGenericClientKeyUpdateRequestAsRs256Private: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AuthorizationUrlInOAuthSfdcPasswordClientKeyUpdateRequest: description: New build-time expression for the authorization endpoint URL. Omit to leave unchanged. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyResponseAsRsaOaep384Private: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - RSA_OAEP_384_PRIVATE type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyResponseAsRs512Private: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - RS512_PRIVATE type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyCreateRequestAsRsaOaep256Public: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - RSA_OAEP_256_PUBLIC type: string required: - algorithm - description - key - name - partner_key_id - type type: object AuthorizationUrlInOAuthLeadPerfectionClientKeyResponse: description: OAuth 2.0 authorization endpoint URL, in build-time evaluatable form. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInOAuthOptimoveClientKeyUpdateRequest: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyCreateRequestAsPassword: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - PASSWORD type: string required: - algorithm - description - key - name - partner_key_id - type type: object AuthorizationUrlInOAuthSfdcClientKeyResponse: description: OAuth 2.0 authorization endpoint URL, in build-time evaluatable form. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string OAuthGenericClientKeyCreateRequest: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - OAUTH_GENERIC type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthGenericClientKeyCreateRequest' oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string request: $ref: '#/components/schemas/RequestInOAuthGenericClientKeyCreateRequest' response_handler: $ref: '#/components/schemas/ResponseHandlerInOAuthGenericClientKeyCreateRequest' scope: description: Optional space-delimited OAuth scopes to request during authorization. nullable: true type: string type: object required: - algorithm - authorization_url - description - key - name - oauth_client_id - partner_key_id - scope - type type: object GenericClientKeyUpdateRequestAsPs512Public: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - PS512_PUBLIC type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsPs512Public' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object AuthorizationUrlInOAuthListrakClientKeyResponse: description: OAuth 2.0 authorization endpoint URL, in build-time evaluatable form. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInGenericClientKeyUpdateRequestAsRs512Private: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyCreateRequestAsRsaOaep384Private: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - RSA_OAEP_384_PRIVATE type: string required: - algorithm - description - key - name - partner_key_id - type type: object GenericClientKeyCreateRequestAsEs512Public: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - ES512_PUBLIC type: string required: - algorithm - description - key - name - partner_key_id - type type: object DescriptionInGenericClientKeyUpdateRequestAsPs384Private: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyResponseAsHs384: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - HS384 type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object OAuthSfdcPasswordClientKeyResponse: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - OAUTH_SFDC_PASSWORD type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthSfdcPasswordClientKeyResponse' id: description: Stable Extole identifier for the client key. readOnly: true type: string oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string password: type: string scope: description: Space-delimited OAuth scopes requested during authorization. nullable: true type: string username: type: string type: object description: Stored oauth sfdc password client key definition. Fields `name`, `description`, and `authorization_url` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - password - scope - tags - type - updated_at - username type: object GenericClientKeyCreateRequestAsRs256Public: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - RS256_PUBLIC type: string required: - algorithm - description - key - name - partner_key_id - type type: object GenericClientKeyUpdateRequestAsRs384Private: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - RS384_PRIVATE type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsRs384Private' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object DescriptionInGenericClientKeyUpdateRequestAsPs512Public: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltGenericClientKeyResponseAsRsaOaep256: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - RSA_OAEP_256 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyResponseAsRs384Private: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - RS384_PRIVATE type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object DescriptionInOAuthSfdcClientKeyUpdateRequest: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AuthorizationUrlInOAuthGenericClientKeyResponse: description: OAuth 2.0 authorization endpoint URL, in build-time evaluatable form. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInGenericClientKeyUpdateRequestAsEs256Public: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyResponseAsRsaOaep512Public: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - RSA_OAEP_512_PUBLIC type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object DescriptionInOAuthClientKeyUpdateRequest: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyCreateRequestAsEs384Private: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - ES384_PRIVATE type: string required: - algorithm - description - key - name - partner_key_id - type type: object DescriptionInGenericClientKeyUpdateRequestAsPs256Private: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ComponentReferenceResponse: properties: component_id: type: string socket_names: items: type: string type: array type: object GenericClientKeyUpdateRequestAsRs384Public: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - RS384_PUBLIC type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsRs384Public' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object ResponseHandlerInOAuthGenericClientKeyResponse: description: 'The response handler as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal response handler properties: accessToken: type: string expiresIn: format: int64 type: integer title: Static Value type: object - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{responseHandler}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('responseHandler');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [OAuthClientKeyResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts). example: handlebars@runtime:{{responseHandler}} externalDocs: description: OAuthClientKeyResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [OAuthClientKeyResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts). example: javascript@runtime:function() { return context.get('responseHandler');} externalDocs: description: OAuthClientKeyResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string DescriptionInGenericClientKeyUpdateRequestAsPs256Public: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyResponseAsEs512Public: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - ES512_PUBLIC type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object DescriptionInGenericClientKeyUpdateRequestAsHs512: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyResponseAsRs384Public: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - RS384_PUBLIC type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object JwtClientKeyVerifyJwtResponse: properties: description: description: Human-readable explanation of the verification outcome. type: string result: description: Verification outcome code. enum: - ALGORITHM_MISMATCH - ALGORITHM_MISSING - DECRYPTION_FAILURE - EXPIRED - KEY_ID_MISMATCH - KEY_ID_MISSING - MALFORMED - MALFORMED_EXP_CLAIM - MALFORMED_NBF_CLAIM - MATCHED - PREMATURE_USE - SIGNATURE_MISMATCH - UNSUPPORTED type: string required: - description - result type: object DescriptionInGenericClientKeyUpdateRequestAsRsaOaep512Public: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInOAuthListrakClientKeyUpdateRequest: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInGenericClientKeyUpdateRequestAsRsa: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string OAuthSalesforceClientKeyUpdateRequest: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - OAUTH_SALESFORCE type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthSalesforceClientKeyUpdateRequest' description: $ref: '#/components/schemas/DescriptionInOAuthSalesforceClientKeyUpdateRequest' key: description: Plain-text OAuth 2.0 client secret. Omit to leave unchanged. type: string oauth_client_id: description: New OAuth 2.0 client identifier. Omit to leave unchanged. type: string scope: description: New space-delimited OAuth scopes. Omit to leave unchanged. nullable: true type: string type: object required: - algorithm type: object OAuthSfdcClientKeyResponse: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - OAUTH_SFDC type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthSfdcClientKeyResponse' id: description: Stable Extole identifier for the client key. readOnly: true type: string oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string scope: description: Space-delimited OAuth scopes requested during authorization. nullable: true type: string type: object description: Stored oauth sfdc client key definition. Fields `name`, `description`, and `authorization_url` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - scope - tags - type - updated_at type: object GenericClientKeyUpdateRequestAsRs512Private: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - RS512_PRIVATE type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsRs512Private' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object BuiltOAuthSfdcClientKeyResponse: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - OAUTH_SFDC type: string authorization_url: type: string id: readOnly: true type: string oauth_client_id: type: string scope: type: string type: object required: - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - scope - tags - type - updated_at type: object OAuthGenericClientKeyUpdateRequest: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - OAUTH_GENERIC type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthGenericClientKeyUpdateRequest' description: $ref: '#/components/schemas/DescriptionInOAuthGenericClientKeyUpdateRequest' key: description: Plain-text OAuth 2.0 client secret. Omit to leave unchanged. type: string oauth_client_id: description: New OAuth 2.0 client identifier. Omit to leave unchanged. type: string request: $ref: '#/components/schemas/RequestInOAuthGenericClientKeyUpdateRequest' response_handler: $ref: '#/components/schemas/ResponseHandlerInOAuthGenericClientKeyUpdateRequest' scope: description: New space-delimited OAuth scopes. Omit to leave unchanged. nullable: true type: string type: object required: - algorithm type: object AuthorizationUrlInOAuthClientKeyUpdateRequest: description: New build-time expression for the authorization endpoint URL. Omit to leave unchanged. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltGenericClientKeyResponseAsRs384: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - RS384 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyUpdateRequestAsPs256Public: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - PS256_PUBLIC type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsPs256Public' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object OAuthClientKeyResponse: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - OAUTH type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthClientKeyResponse' id: description: Stable Extole identifier for the client key. readOnly: true type: string oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string scope: description: Space-delimited OAuth scopes requested during authorization. nullable: true type: string type: object description: Stored oauth client key definition. Fields `name`, `description`, and `authorization_url` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - scope - tags - type - updated_at type: object GenericClientKeyUpdateRequestAsEs256Private: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - ES256_PRIVATE type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsEs256Private' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object BuiltGenericClientKeyResponseAsRs512: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - RS512 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyResponseAsRsaOaep512Private: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - RSA_OAEP_512_PRIVATE type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyResponseAsA256kw: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - A256KW type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyCreateRequestAsRs384Public: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - RS384_PUBLIC type: string required: - algorithm - description - key - name - partner_key_id - type type: object GenericClientKeyResponseAsRs256Private: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - RS256_PRIVATE type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object BuiltGenericClientKeyResponseAsEs512: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - ES512 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyCreateRequestAsEs512Private: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - ES512_PRIVATE type: string required: - algorithm - description - key - name - partner_key_id - type type: object AuthorizationUrlInOAuthOptimoveClientKeyCreateRequest: description: Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyCreateRequestAsA128kw: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - A128KW type: string required: - algorithm - description - key - name - partner_key_id - type type: object GenericClientKeyCreateRequestAsRsaOaep384Public: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - RSA_OAEP_384_PUBLIC type: string required: - algorithm - description - key - name - partner_key_id - type type: object SslPkcs12ClientKeyResponse: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - SSL_PKCS_12 type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string password: type: string type: object description: Stored ssl pkcs12client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - password - tags - type - updated_at type: object GenericClientKeyResponseAsRs512Public: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - RS512_PUBLIC type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyResponseAsEs256Public: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - ES256_PUBLIC type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object BuiltOAuthLeadPerfectionClientKeyResponse: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - OAUTH_LEAD_PERFECTION type: string appKey: type: string app_key: type: string writeOnly: true authorization_url: type: string id: readOnly: true type: string leadPerfectionClientId: type: string lead_perfection_client_id: type: string writeOnly: true oauth_client_id: type: string scope: type: string type: object required: - algorithm - appKey - authorization_url - component_ids - component_references - created_at - description - id - key - leadPerfectionClientId - name - oauth_client_id - partner_key_id - scope - tags - type - updated_at type: object GenericClientKeyResponseAsHs512: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - HS512 type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyUpdateRequestAsHs256: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - HS256 type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsHs256' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object BuiltClientKeyResponse: description: client key after buildtime evaluation. Fields `name` and `description` are already evaluated. discriminator: mapping: A128KW: '#/components/schemas/BuiltGenericClientKeyResponseAsA128kw' A192KW: '#/components/schemas/BuiltGenericClientKeyResponseAsA192kw' A256KW: '#/components/schemas/BuiltGenericClientKeyResponseAsA256kw' ES256: '#/components/schemas/BuiltGenericClientKeyResponseAsEs256' ES384: '#/components/schemas/BuiltGenericClientKeyResponseAsEs384' ES512: '#/components/schemas/BuiltGenericClientKeyResponseAsEs512' HS256: '#/components/schemas/BuiltGenericClientKeyResponseAsHs256' HS384: '#/components/schemas/BuiltGenericClientKeyResponseAsHs384' HS512: '#/components/schemas/BuiltGenericClientKeyResponseAsHs512' HTTP_BASIC: '#/components/schemas/BuiltGenericClientKeyResponseAsHttpBasic' OAUTH: '#/components/schemas/BuiltOAuthClientKeyResponse' OAUTH_GENERIC: '#/components/schemas/BuiltOAuthGenericClientKeyResponse' OAUTH_LEAD_PERFECTION: '#/components/schemas/BuiltOAuthLeadPerfectionClientKeyResponse' OAUTH_LISTRAK: '#/components/schemas/BuiltOAuthListrakClientKeyResponse' OAUTH_OPTIMOVE: '#/components/schemas/BuiltOAuthOptimoveClientKeyResponse' OAUTH_SALESFORCE: '#/components/schemas/BuiltOAuthSalesforceClientKeyResponse' OAUTH_SFDC: '#/components/schemas/BuiltOAuthSfdcClientKeyResponse' OAUTH_SFDC_PASSWORD: '#/components/schemas/BuiltOAuthSfdcPasswordClientKeyResponse' PASSWORD: '#/components/schemas/BuiltGenericClientKeyResponseAsPassword' PS256: '#/components/schemas/BuiltGenericClientKeyResponseAsPs256' PS384: '#/components/schemas/BuiltGenericClientKeyResponseAsPs384' PS512: '#/components/schemas/BuiltGenericClientKeyResponseAsPs512' RS256: '#/components/schemas/BuiltGenericClientKeyResponseAsRs256' RS384: '#/components/schemas/BuiltGenericClientKeyResponseAsRs384' RS512: '#/components/schemas/BuiltGenericClientKeyResponseAsRs512' RSA: '#/components/schemas/BuiltGenericClientKeyResponseAsRsa' RSA_OAEP_256: '#/components/schemas/BuiltGenericClientKeyResponseAsRsaOaep256' RSA_OAEP_384: '#/components/schemas/BuiltGenericClientKeyResponseAsRsaOaep384' RSA_OAEP_512: '#/components/schemas/BuiltGenericClientKeyResponseAsRsaOaep512' SSL_PKCS_12: '#/components/schemas/BuiltSslPkcs12ClientKeyResponse' propertyName: algorithm oneOf: - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsA128kw' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsA192kw' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsA256kw' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsEs256' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsEs384' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsEs512' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsHs256' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsHs384' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsHs512' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsHttpBasic' - $ref: '#/components/schemas/BuiltOAuthClientKeyResponse' - $ref: '#/components/schemas/BuiltOAuthGenericClientKeyResponse' - $ref: '#/components/schemas/BuiltOAuthLeadPerfectionClientKeyResponse' - $ref: '#/components/schemas/BuiltOAuthListrakClientKeyResponse' - $ref: '#/components/schemas/BuiltOAuthOptimoveClientKeyResponse' - $ref: '#/components/schemas/BuiltOAuthSalesforceClientKeyResponse' - $ref: '#/components/schemas/BuiltOAuthSfdcClientKeyResponse' - $ref: '#/components/schemas/BuiltOAuthSfdcPasswordClientKeyResponse' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsPassword' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsPs256' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsPs384' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsPs512' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsRs256' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsRs384' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsRs512' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsRsa' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsRsaOaep256' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsRsaOaep384' - $ref: '#/components/schemas/BuiltGenericClientKeyResponseAsRsaOaep512' - $ref: '#/components/schemas/BuiltSslPkcs12ClientKeyResponse' required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at GenericClientKeyUpdateRequestAsRs256Private: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - RS256_PRIVATE type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsRs256Private' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object OAuthLeadPerfectionClientKeyResponse: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - OAUTH_LEAD_PERFECTION type: string appKey: type: string app_key: type: string writeOnly: true authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthLeadPerfectionClientKeyResponse' id: description: Stable Extole identifier for the client key. readOnly: true type: string leadPerfectionClientId: type: string lead_perfection_client_id: type: string writeOnly: true oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string scope: description: Space-delimited OAuth scopes requested during authorization. nullable: true type: string type: object description: Stored oauth lead perfection client key definition. Fields `name`, `description`, and `authorization_url` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - appKey - authorization_url - component_ids - component_references - created_at - description - id - key - leadPerfectionClientId - name - oauth_client_id - partner_key_id - scope - tags - type - updated_at type: object GenericClientKeyResponseAsPs384Public: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - PS384_PUBLIC type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyResponseAsPs512Private: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - PS512_PRIVATE type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object DescriptionInGenericClientKeyUpdateRequestAsEs384Public: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string SslPkcs12ClientKeyUpdateRequest: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - SSL_PKCS_12 type: string description: $ref: '#/components/schemas/DescriptionInSslPkcs12ClientKeyUpdateRequest' type: object required: - algorithm type: object BuiltOAuthSalesforceClientKeyResponse: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: account_id: format: int32 type: integer algorithm: enum: - OAUTH_SALESFORCE type: string authorization_url: type: string id: readOnly: true type: string oauth_client_id: type: string scope: type: string type: object required: - account_id - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - scope - tags - type - updated_at type: object BuiltGenericClientKeyResponseAsRs256: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - RS256 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyUpdateRequestAsRsaOaep384Public: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - RSA_OAEP_384_PUBLIC type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsRsaOaep384Public' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object GenericClientKeyCreateRequestAsPs384Public: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - PS384_PUBLIC type: string required: - algorithm - description - key - name - partner_key_id - type type: object GenericClientKeyResponseAsPs512Public: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - PS512_PUBLIC type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object OAuthSfdcClientKeyUpdateRequest: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - OAUTH_SFDC type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthSfdcClientKeyUpdateRequest' description: $ref: '#/components/schemas/DescriptionInOAuthSfdcClientKeyUpdateRequest' key: description: Plain-text OAuth 2.0 client secret. Omit to leave unchanged. type: string oauth_client_id: description: New OAuth 2.0 client identifier. Omit to leave unchanged. type: string scope: description: New space-delimited OAuth scopes. Omit to leave unchanged. nullable: true type: string type: object required: - algorithm type: object ResponseHandlerInOAuthGenericClientKeyUpdateRequest: description: Choose between static or dynamic response handler oneOf: - description: Static response handler properties: accessToken: type: string expiresIn: format: int64 type: integer title: Static Value type: object - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{responseHandler}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('responseHandler');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [OAuthClientKeyResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts). example: handlebars@runtime:{{responseHandler}} externalDocs: description: OAuthClientKeyResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [OAuthClientKeyResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts). example: javascript@runtime:function() { return context.get('responseHandler');} externalDocs: description: OAuthClientKeyResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string OAuthGenericClientKeyResponse: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - OAUTH_GENERIC type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthGenericClientKeyResponse' id: description: Stable Extole identifier for the client key. readOnly: true type: string oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string request: $ref: '#/components/schemas/RequestInOAuthGenericClientKeyResponse' response_handler: $ref: '#/components/schemas/ResponseHandlerInOAuthGenericClientKeyResponse' scope: description: Space-delimited OAuth scopes requested during authorization. nullable: true type: string type: object description: Stored oauth generic client key definition. Fields `name`, `description`, `authorization_url`, `request`, and `response_handler` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - request - response_handler - scope - tags - type - updated_at type: object NameInClientKeyResponseBase: description: Display name for the key, in the same build-time evaluatable form that was supplied on create or update. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal name title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{name}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('name');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string JwtClientKeyVerifyJwtRequest: properties: jwt: description: JWT string to verify against active client keys in the program. type: string required: - jwt type: object OAuthClientKeyUpdateRequest: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - OAUTH type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthClientKeyUpdateRequest' description: $ref: '#/components/schemas/DescriptionInOAuthClientKeyUpdateRequest' key: description: Plain-text OAuth 2.0 client secret. Omit to leave unchanged. type: string oauth_client_id: description: New OAuth 2.0 client identifier. Omit to leave unchanged. type: string scope: description: New space-delimited OAuth scopes. Omit to leave unchanged. nullable: true type: string type: object required: - algorithm type: object GenericClientKeyUpdateRequestAsRsaOaep512Public: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - RSA_OAEP_512_PUBLIC type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsRsaOaep512Public' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object OAuthSfdcClientKeyCreateRequest: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - OAUTH_SFDC type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthSfdcClientKeyCreateRequest' oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string scope: description: Optional space-delimited OAuth scopes to request during authorization. nullable: true type: string type: object required: - algorithm - authorization_url - description - key - name - oauth_client_id - partner_key_id - scope - type type: object BuiltClientKeyResponseBase: properties: algorithm: description: Cryptographic or integration algorithm. Discriminator for polymorphic create, update, and response schemas. enum: - A128KW - A192KW - A256KW - ES256_PRIVATE - ES256_PUBLIC - ES384_PRIVATE - ES384_PUBLIC - ES512_PRIVATE - ES512_PUBLIC - GENERIC - HS256 - HS384 - HS512 - HTTP_BASIC - OAUTH - OAUTH_GENERIC - OAUTH_LEAD_PERFECTION - OAUTH_LISTRAK - OAUTH_OPTIMOVE - OAUTH_SALESFORCE - OAUTH_SFDC - OAUTH_SFDC_PASSWORD - PASSWORD - PS256_PRIVATE - PS256_PUBLIC - PS384_PRIVATE - PS384_PUBLIC - PS512_PRIVATE - PS512_PUBLIC - RS256_PRIVATE - RS256_PUBLIC - RS384_PRIVATE - RS384_PUBLIC - RS512_PRIVATE - RS512_PUBLIC - RSA - RSA_OAEP_256_PRIVATE - RSA_OAEP_256_PUBLIC - RSA_OAEP_384_PRIVATE - RSA_OAEP_384_PUBLIC - RSA_OAEP_512_PRIVATE - RSA_OAEP_512_PUBLIC - SSL_PKCS_12 type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array created_at: $ref: '#/components/schemas/ZonedDateTime' description: type: string id: readOnly: true type: string key: description: Evaluated key material in the same encoding as on create. Symmetric secrets and private keys are partially masked; public keys are returned in full PEM form. type: string name: type: string partner_key_id: type: string tags: items: type: string type: array uniqueItems: true type: description: Usage category that determines how the key is consumed at runtime. enum: - JWT - PASSWORD - PGP - PGP_EXTOLE - SSH - WEBHOOK type: string updated_at: $ref: '#/components/schemas/ZonedDateTime' type: object DescriptionInGenericClientKeyUpdateRequestAsPs384Public: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltOAuthSfdcPasswordClientKeyResponse: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - OAUTH_SFDC_PASSWORD type: string authorization_url: type: string id: readOnly: true type: string oauth_client_id: type: string password: type: string scope: type: string username: type: string type: object required: - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - password - scope - tags - type - updated_at - username type: object DescriptionInGenericClientKeyUpdateRequestAsEs256Private: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AuthorizationUrlInOAuthSalesforceClientKeyCreateRequest: description: Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AuthorizationUrlInOAuthClientKeyResponse: description: OAuth 2.0 authorization endpoint URL, in build-time evaluatable form. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyCreateRequestAsRs384Private: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - RS384_PRIVATE type: string required: - algorithm - description - key - name - partner_key_id - type type: object OAuthOptimoveClientKeyResponse: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - OAUTH_OPTIMOVE type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthOptimoveClientKeyResponse' id: description: Stable Extole identifier for the client key. readOnly: true type: string oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string scope: description: Space-delimited OAuth scopes requested during authorization. nullable: true type: string type: object description: Stored oauth optimove client key definition. Fields `name`, `description`, and `authorization_url` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - scope - tags - type - updated_at type: object BuiltGenericClientKeyResponseAsA256kw: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - A256KW type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyUpdateRequestAsRsaOaep256Public: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - RSA_OAEP_256_PUBLIC type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsRsaOaep256Public' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object AuthorizationUrlInOAuthOptimoveClientKeyUpdateRequest: description: New build-time expression for the authorization endpoint URL. Omit to leave unchanged. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyResponseAsRsaOaep256Private: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - RSA_OAEP_256_PRIVATE type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object OAuthLeadPerfectionClientKeyUpdateRequest: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - OAUTH_LEAD_PERFECTION type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthLeadPerfectionClientKeyUpdateRequest' description: $ref: '#/components/schemas/DescriptionInOAuthLeadPerfectionClientKeyUpdateRequest' key: description: Plain-text OAuth 2.0 client secret. Omit to leave unchanged. type: string oauth_client_id: description: New OAuth 2.0 client identifier. Omit to leave unchanged. type: string scope: description: New space-delimited OAuth scopes. Omit to leave unchanged. nullable: true type: string type: object required: - algorithm type: object OAuthClientKeyCreateRequest: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - OAUTH type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthClientKeyCreateRequest' oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string scope: description: Optional space-delimited OAuth scopes to request during authorization. nullable: true type: string type: object required: - algorithm - authorization_url - description - key - name - oauth_client_id - partner_key_id - scope - type type: object GenericClientKeyUpdateRequestAsRs256Public: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - RS256_PUBLIC type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsRs256Public' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object GenericClientKeyResponseAsA128kw: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - A128KW type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object DescriptionInGenericClientKeyUpdateRequestAsEs512Public: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInGenericClientKeyUpdateRequestAsRsaOaep384Private: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInGenericClientKeyUpdateRequestAsRsaOaep512Private: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string OAuthSalesforceClientKeyResponse: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: account_id: format: int32 type: integer algorithm: enum: - OAUTH_SALESFORCE type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthSalesforceClientKeyResponse' id: description: Stable Extole identifier for the client key. readOnly: true type: string oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string scope: description: Space-delimited OAuth scopes requested during authorization. nullable: true type: string type: object description: Stored oauth salesforce client key definition. Fields `name`, `description`, and `authorization_url` are unevaluated and appear in buildtime-evaluatable form. required: - account_id - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - scope - tags - type - updated_at type: object DescriptionInGenericClientKeyUpdateRequestAsPs512Private: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyResponseAsPs384Private: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - PS384_PRIVATE type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object AuthorizationUrlInOAuthOptimoveClientKeyResponse: description: OAuth 2.0 authorization endpoint URL, in build-time evaluatable form. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AuthorizationUrlInOAuthSalesforceClientKeyUpdateRequest: description: New build-time expression for the authorization endpoint URL. Omit to leave unchanged. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyUpdateRequestAsPs384Private: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - PS384_PRIVATE type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsPs384Private' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object GenericClientKeyCreateRequestAsPs512Private: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - PS512_PRIVATE type: string required: - algorithm - description - key - name - partner_key_id - type type: object GenericClientKeyUpdateRequestAsA256kw: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - A256KW type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsA256kw' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object AuthorizationUrlInOAuthLeadPerfectionClientKeyUpdateRequest: description: New build-time expression for the authorization endpoint URL. Omit to leave unchanged. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyUpdateRequestAsEs512Public: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - ES512_PUBLIC type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsEs512Public' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object DescriptionInStringBasedClientKeyCreateRequestBase: description: Optional build-time expression that resolves to a human-readable description. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyResponseAsEs512Private: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - ES512_PRIVATE type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyCreateRequestAsPs256Public: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - PS256_PUBLIC type: string required: - algorithm - description - key - name - partner_key_id - type type: object GenericClientKeyUpdateRequestAsRs512Public: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - RS512_PUBLIC type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsRs512Public' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object BuiltGenericClientKeyResponseAsEs256: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - ES256 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object BuiltGenericClientKeyResponseAsPs384: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - PS384 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object ClientKeyResponse: discriminator: mapping: A128KW: '#/components/schemas/GenericClientKeyResponseAsA128kw' A192KW: '#/components/schemas/GenericClientKeyResponseAsA192kw' A256KW: '#/components/schemas/GenericClientKeyResponseAsA256kw' ES256_PRIVATE: '#/components/schemas/GenericClientKeyResponseAsEs256Private' ES256_PUBLIC: '#/components/schemas/GenericClientKeyResponseAsEs256Public' ES384_PRIVATE: '#/components/schemas/GenericClientKeyResponseAsEs384Private' ES384_PUBLIC: '#/components/schemas/GenericClientKeyResponseAsEs384Public' ES512_PRIVATE: '#/components/schemas/GenericClientKeyResponseAsEs512Private' ES512_PUBLIC: '#/components/schemas/GenericClientKeyResponseAsEs512Public' HS256: '#/components/schemas/GenericClientKeyResponseAsHs256' HS384: '#/components/schemas/GenericClientKeyResponseAsHs384' HS512: '#/components/schemas/GenericClientKeyResponseAsHs512' HTTP_BASIC: '#/components/schemas/GenericClientKeyResponseAsHttpBasic' OAUTH: '#/components/schemas/OAuthClientKeyResponse' OAUTH_GENERIC: '#/components/schemas/OAuthGenericClientKeyResponse' OAUTH_LEAD_PERFECTION: '#/components/schemas/OAuthLeadPerfectionClientKeyResponse' OAUTH_LISTRAK: '#/components/schemas/OAuthListrakClientKeyResponse' OAUTH_OPTIMOVE: '#/components/schemas/OAuthOptimoveClientKeyResponse' OAUTH_SALESFORCE: '#/components/schemas/OAuthSalesforceClientKeyResponse' OAUTH_SFDC: '#/components/schemas/OAuthSfdcClientKeyResponse' OAUTH_SFDC_PASSWORD: '#/components/schemas/OAuthSfdcPasswordClientKeyResponse' PASSWORD: '#/components/schemas/GenericClientKeyResponseAsPassword' PS256_PRIVATE: '#/components/schemas/GenericClientKeyResponseAsPs256Private' PS256_PUBLIC: '#/components/schemas/GenericClientKeyResponseAsPs256Public' PS384_PRIVATE: '#/components/schemas/GenericClientKeyResponseAsPs384Private' PS384_PUBLIC: '#/components/schemas/GenericClientKeyResponseAsPs384Public' PS512_PRIVATE: '#/components/schemas/GenericClientKeyResponseAsPs512Private' PS512_PUBLIC: '#/components/schemas/GenericClientKeyResponseAsPs512Public' RS256_PRIVATE: '#/components/schemas/GenericClientKeyResponseAsRs256Private' RS256_PUBLIC: '#/components/schemas/GenericClientKeyResponseAsRs256Public' RS384_PRIVATE: '#/components/schemas/GenericClientKeyResponseAsRs384Private' RS384_PUBLIC: '#/components/schemas/GenericClientKeyResponseAsRs384Public' RS512_PRIVATE: '#/components/schemas/GenericClientKeyResponseAsRs512Private' RS512_PUBLIC: '#/components/schemas/GenericClientKeyResponseAsRs512Public' RSA: '#/components/schemas/GenericClientKeyResponseAsRsa' RSA_OAEP_256_PRIVATE: '#/components/schemas/GenericClientKeyResponseAsRsaOaep256Private' RSA_OAEP_256_PUBLIC: '#/components/schemas/GenericClientKeyResponseAsRsaOaep256Public' RSA_OAEP_384_PRIVATE: '#/components/schemas/GenericClientKeyResponseAsRsaOaep384Private' RSA_OAEP_384_PUBLIC: '#/components/schemas/GenericClientKeyResponseAsRsaOaep384Public' RSA_OAEP_512_PRIVATE: '#/components/schemas/GenericClientKeyResponseAsRsaOaep512Private' RSA_OAEP_512_PUBLIC: '#/components/schemas/GenericClientKeyResponseAsRsaOaep512Public' SSL_PKCS_12: '#/components/schemas/SslPkcs12ClientKeyResponse' propertyName: algorithm oneOf: - $ref: '#/components/schemas/GenericClientKeyResponseAsA128kw' - $ref: '#/components/schemas/GenericClientKeyResponseAsA192kw' - $ref: '#/components/schemas/GenericClientKeyResponseAsA256kw' - $ref: '#/components/schemas/GenericClientKeyResponseAsEs256Private' - $ref: '#/components/schemas/GenericClientKeyResponseAsEs256Public' - $ref: '#/components/schemas/GenericClientKeyResponseAsEs384Private' - $ref: '#/components/schemas/GenericClientKeyResponseAsEs384Public' - $ref: '#/components/schemas/GenericClientKeyResponseAsEs512Private' - $ref: '#/components/schemas/GenericClientKeyResponseAsEs512Public' - $ref: '#/components/schemas/GenericClientKeyResponseAsHs256' - $ref: '#/components/schemas/GenericClientKeyResponseAsHs384' - $ref: '#/components/schemas/GenericClientKeyResponseAsHs512' - $ref: '#/components/schemas/GenericClientKeyResponseAsHttpBasic' - $ref: '#/components/schemas/OAuthClientKeyResponse' - $ref: '#/components/schemas/OAuthGenericClientKeyResponse' - $ref: '#/components/schemas/OAuthLeadPerfectionClientKeyResponse' - $ref: '#/components/schemas/OAuthListrakClientKeyResponse' - $ref: '#/components/schemas/OAuthOptimoveClientKeyResponse' - $ref: '#/components/schemas/OAuthSalesforceClientKeyResponse' - $ref: '#/components/schemas/OAuthSfdcClientKeyResponse' - $ref: '#/components/schemas/OAuthSfdcPasswordClientKeyResponse' - $ref: '#/components/schemas/GenericClientKeyResponseAsPassword' - $ref: '#/components/schemas/GenericClientKeyResponseAsPs256Private' - $ref: '#/components/schemas/GenericClientKeyResponseAsPs256Public' - $ref: '#/components/schemas/GenericClientKeyResponseAsPs384Private' - $ref: '#/components/schemas/GenericClientKeyResponseAsPs384Public' - $ref: '#/components/schemas/GenericClientKeyResponseAsPs512Private' - $ref: '#/components/schemas/GenericClientKeyResponseAsPs512Public' - $ref: '#/components/schemas/GenericClientKeyResponseAsRs256Private' - $ref: '#/components/schemas/GenericClientKeyResponseAsRs256Public' - $ref: '#/components/schemas/GenericClientKeyResponseAsRs384Private' - $ref: '#/components/schemas/GenericClientKeyResponseAsRs384Public' - $ref: '#/components/schemas/GenericClientKeyResponseAsRs512Private' - $ref: '#/components/schemas/GenericClientKeyResponseAsRs512Public' - $ref: '#/components/schemas/GenericClientKeyResponseAsRsa' - $ref: '#/components/schemas/GenericClientKeyResponseAsRsaOaep256Private' - $ref: '#/components/schemas/GenericClientKeyResponseAsRsaOaep256Public' - $ref: '#/components/schemas/GenericClientKeyResponseAsRsaOaep384Private' - $ref: '#/components/schemas/GenericClientKeyResponseAsRsaOaep384Public' - $ref: '#/components/schemas/GenericClientKeyResponseAsRsaOaep512Private' - $ref: '#/components/schemas/GenericClientKeyResponseAsRsaOaep512Public' - $ref: '#/components/schemas/SslPkcs12ClientKeyResponse' required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at GenericClientKeyResponseAsPassword: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - PASSWORD type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object BuiltOAuthGenericClientKeyResponse: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - OAUTH_GENERIC type: string authorization_url: type: string id: readOnly: true type: string oauth_client_id: type: string request: $ref: '#/components/schemas/RequestInBuiltOAuthGenericClientKeyResponse' response_handler: $ref: '#/components/schemas/ResponseHandlerInBuiltOAuthGenericClientKeyResponse' scope: type: string type: object required: - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - request - response_handler - scope - tags - type - updated_at type: object GenericClientKeyResponseAsRs256Public: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - RS256_PUBLIC type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyResponseAsEs384Private: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - ES384_PRIVATE type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyCreateRequestAsRsaOaep512Public: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - RSA_OAEP_512_PUBLIC type: string required: - algorithm - description - key - name - partner_key_id - type type: object DescriptionInGenericClientKeyUpdateRequestAsHs256: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AuthorizationUrlInOAuthSfdcClientKeyCreateRequest: description: Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltGenericClientKeyResponseAsA128kw: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - A128KW type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object DescriptionInGenericClientKeyUpdateRequestAsHs384: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyCreateRequestAsA256kw: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - A256KW type: string required: - algorithm - description - key - name - partner_key_id - type type: object BuiltGenericClientKeyResponseAsRsaOaep512: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - RSA_OAEP_512 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyCreateRequestAsA192kw: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - A192KW type: string required: - algorithm - description - key - name - partner_key_id - type type: object GenericClientKeyUpdateRequestAsA128kw: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - A128KW type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsA128kw' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object BuiltGenericClientKeyResponseAsHs384: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - HS384 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object BuiltOAuthListrakClientKeyResponse: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - OAUTH_LISTRAK type: string authorization_url: type: string id: readOnly: true type: string oauth_client_id: type: string scope: type: string type: object required: - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - scope - tags - type - updated_at type: object BuiltSslPkcs12ClientKeyResponse: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - SSL_PKCS_12 type: string id: readOnly: true type: string password: type: string type: object description: ssl pkcs12client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - password - tags - type - updated_at type: object StringBasedClientKeyCreateRequest: description: Body of a `POST /v2/settings/security/keys` request. discriminator: mapping: A128KW: '#/components/schemas/GenericClientKeyCreateRequestAsA128kw' A192KW: '#/components/schemas/GenericClientKeyCreateRequestAsA192kw' A256KW: '#/components/schemas/GenericClientKeyCreateRequestAsA256kw' ES256_PRIVATE: '#/components/schemas/GenericClientKeyCreateRequestAsEs256Private' ES256_PUBLIC: '#/components/schemas/GenericClientKeyCreateRequestAsEs256Public' ES384_PRIVATE: '#/components/schemas/GenericClientKeyCreateRequestAsEs384Private' ES384_PUBLIC: '#/components/schemas/GenericClientKeyCreateRequestAsEs384Public' ES512_PRIVATE: '#/components/schemas/GenericClientKeyCreateRequestAsEs512Private' ES512_PUBLIC: '#/components/schemas/GenericClientKeyCreateRequestAsEs512Public' HS256: '#/components/schemas/GenericClientKeyCreateRequestAsHs256' HS384: '#/components/schemas/GenericClientKeyCreateRequestAsHs384' HS512: '#/components/schemas/GenericClientKeyCreateRequestAsHs512' HTTP_BASIC: '#/components/schemas/GenericClientKeyCreateRequestAsHttpBasic' OAUTH: '#/components/schemas/OAuthClientKeyCreateRequest' OAUTH_GENERIC: '#/components/schemas/OAuthGenericClientKeyCreateRequest' OAUTH_LEAD_PERFECTION: '#/components/schemas/OAuthLeadPerfectionClientKeyCreateRequest' OAUTH_LISTRAK: '#/components/schemas/OAuthListrakClientKeyCreateRequest' OAUTH_OPTIMOVE: '#/components/schemas/OAuthOptimoveClientKeyCreateRequest' OAUTH_SALESFORCE: '#/components/schemas/OAuthSalesforceClientKeyCreateRequest' OAUTH_SFDC: '#/components/schemas/OAuthSfdcClientKeyCreateRequest' OAUTH_SFDC_PASSWORD: '#/components/schemas/OAuthSfdcPasswordClientKeyCreateRequest' PASSWORD: '#/components/schemas/GenericClientKeyCreateRequestAsPassword' PS256_PRIVATE: '#/components/schemas/GenericClientKeyCreateRequestAsPs256Private' PS256_PUBLIC: '#/components/schemas/GenericClientKeyCreateRequestAsPs256Public' PS384_PRIVATE: '#/components/schemas/GenericClientKeyCreateRequestAsPs384Private' PS384_PUBLIC: '#/components/schemas/GenericClientKeyCreateRequestAsPs384Public' PS512_PRIVATE: '#/components/schemas/GenericClientKeyCreateRequestAsPs512Private' PS512_PUBLIC: '#/components/schemas/GenericClientKeyCreateRequestAsPs512Public' RS256_PRIVATE: '#/components/schemas/GenericClientKeyCreateRequestAsRs256Private' RS256_PUBLIC: '#/components/schemas/GenericClientKeyCreateRequestAsRs256Public' RS384_PRIVATE: '#/components/schemas/GenericClientKeyCreateRequestAsRs384Private' RS384_PUBLIC: '#/components/schemas/GenericClientKeyCreateRequestAsRs384Public' RS512_PRIVATE: '#/components/schemas/GenericClientKeyCreateRequestAsRs512Private' RS512_PUBLIC: '#/components/schemas/GenericClientKeyCreateRequestAsRs512Public' RSA: '#/components/schemas/GenericClientKeyCreateRequestAsRsa' RSA_OAEP_256_PRIVATE: '#/components/schemas/GenericClientKeyCreateRequestAsRsaOaep256Private' RSA_OAEP_256_PUBLIC: '#/components/schemas/GenericClientKeyCreateRequestAsRsaOaep256Public' RSA_OAEP_384_PRIVATE: '#/components/schemas/GenericClientKeyCreateRequestAsRsaOaep384Private' RSA_OAEP_384_PUBLIC: '#/components/schemas/GenericClientKeyCreateRequestAsRsaOaep384Public' RSA_OAEP_512_PRIVATE: '#/components/schemas/GenericClientKeyCreateRequestAsRsaOaep512Private' RSA_OAEP_512_PUBLIC: '#/components/schemas/GenericClientKeyCreateRequestAsRsaOaep512Public' propertyName: algorithm oneOf: - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsA128kw' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsA192kw' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsA256kw' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsEs256Private' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsEs256Public' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsEs384Private' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsEs384Public' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsEs512Private' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsEs512Public' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsHs256' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsHs384' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsHs512' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsHttpBasic' - $ref: '#/components/schemas/OAuthClientKeyCreateRequest' - $ref: '#/components/schemas/OAuthGenericClientKeyCreateRequest' - $ref: '#/components/schemas/OAuthLeadPerfectionClientKeyCreateRequest' - $ref: '#/components/schemas/OAuthListrakClientKeyCreateRequest' - $ref: '#/components/schemas/OAuthOptimoveClientKeyCreateRequest' - $ref: '#/components/schemas/OAuthSalesforceClientKeyCreateRequest' - $ref: '#/components/schemas/OAuthSfdcClientKeyCreateRequest' - $ref: '#/components/schemas/OAuthSfdcPasswordClientKeyCreateRequest' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsPassword' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsPs256Private' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsPs256Public' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsPs384Private' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsPs384Public' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsPs512Private' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsPs512Public' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsRs256Private' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsRs256Public' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsRs384Private' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsRs384Public' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsRs512Private' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsRs512Public' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsRsa' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsRsaOaep256Private' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsRsaOaep256Public' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsRsaOaep384Private' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsRsaOaep384Public' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsRsaOaep512Private' - $ref: '#/components/schemas/GenericClientKeyCreateRequestAsRsaOaep512Public' required: - algorithm - description - key - name - partner_key_id - type GenericClientKeyCreateRequestAsRsa: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - RSA type: string required: - algorithm - description - key - name - partner_key_id - type type: object OAuthLeadPerfectionClientKeyCreateRequest: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - OAUTH_LEAD_PERFECTION type: string app_key: type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthLeadPerfectionClientKeyCreateRequest' lead_perfection_client_id: type: string oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string scope: description: Optional space-delimited OAuth scopes to request during authorization. nullable: true type: string type: object required: - algorithm - authorization_url - description - key - name - oauth_client_id - partner_key_id - scope - type type: object BuiltOAuthClientKeyResponse: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - OAUTH type: string authorization_url: type: string id: readOnly: true type: string oauth_client_id: type: string scope: type: string type: object required: - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - scope - tags - type - updated_at type: object AuthorizationUrlInOAuthGenericClientKeyCreateRequest: description: Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyCreateRequestAsHs512: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - HS512 type: string required: - algorithm - description - key - name - partner_key_id - type type: object OAuthSfdcPasswordClientKeyCreateRequest: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - OAUTH_SFDC_PASSWORD type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthSfdcPasswordClientKeyCreateRequest' oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string password: type: string scope: description: Optional space-delimited OAuth scopes to request during authorization. nullable: true type: string username: type: string type: object required: - algorithm - authorization_url - description - key - name - oauth_client_id - partner_key_id - password - scope - type - username type: object RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: Attributes related to the error, varies be error code, documented per endpoint type: object description: Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object GenericClientKeyUpdateRequestAsPs512Private: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - PS512_PRIVATE type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsPs512Private' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object AuthorizationUrlInOAuthListrakClientKeyCreateRequest: description: Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInClientKeyResponseBase: description: Optional build-time expression that resolves to a human-readable description. oneOf: - description: Literal description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ComponentReferenceRequest: properties: component_id: type: string socket_names: items: type: string type: array type: object BuiltGenericClientKeyResponseAsPassword: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - PASSWORD type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyUpdateRequestAsRsa: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - RSA type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsRsa' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object OAuthListrakClientKeyUpdateRequest: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - OAUTH_LISTRAK type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthListrakClientKeyUpdateRequest' description: $ref: '#/components/schemas/DescriptionInOAuthListrakClientKeyUpdateRequest' key: description: Plain-text OAuth 2.0 client secret. Omit to leave unchanged. type: string oauth_client_id: description: New OAuth 2.0 client identifier. Omit to leave unchanged. type: string scope: description: New space-delimited OAuth scopes. Omit to leave unchanged. nullable: true type: string type: object required: - algorithm type: object BuiltOAuthOptimoveClientKeyResponse: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - OAUTH_OPTIMOVE type: string authorization_url: type: string id: readOnly: true type: string oauth_client_id: type: string scope: type: string type: object required: - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - scope - tags - type - updated_at type: object GenericClientKeyCreateRequestAsPs512Public: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - PS512_PUBLIC type: string required: - algorithm - description - key - name - partner_key_id - type type: object DescriptionInGenericClientKeyUpdateRequestAsEs512Private: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyUpdateRequestAsRsaOaep384Private: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - RSA_OAEP_384_PRIVATE type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsRsaOaep384Private' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object DescriptionInSslPkcs12ClientKeyUpdateRequest: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ResponseHandlerInBuiltOAuthGenericClientKeyResponse: description: 'The response handler as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal response handler properties: accessToken: type: string expiresIn: format: int64 type: integer title: Static Value type: object - description: Handlebars expression with [OAuthClientKeyResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts). example: handlebars@runtime:{{responseHandler}} externalDocs: description: OAuthClientKeyResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [OAuthClientKeyResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts). example: javascript@runtime:function() { return context.get('responseHandler');} externalDocs: description: OAuthClientKeyResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string GenericClientKeyUpdateRequestAsHttpBasic: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - HTTP_BASIC type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsHttpBasic' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object GenericClientKeyUpdateRequestAsRsaOaep512Private: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - RSA_OAEP_512_PRIVATE type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsRsaOaep512Private' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object DescriptionInOAuthSfdcPasswordClientKeyUpdateRequest: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string StringBasedClientKeyCreateRequestBase: properties: algorithm: description: Cryptographic or integration algorithm. Discriminator for polymorphic create, update, and response schemas. enum: - A128KW - A192KW - A256KW - ES256_PRIVATE - ES256_PUBLIC - ES384_PRIVATE - ES384_PUBLIC - ES512_PRIVATE - ES512_PUBLIC - GENERIC - HS256 - HS384 - HS512 - HTTP_BASIC - OAUTH - OAUTH_GENERIC - OAUTH_LEAD_PERFECTION - OAUTH_LISTRAK - OAUTH_OPTIMOVE - OAUTH_SALESFORCE - OAUTH_SFDC - OAUTH_SFDC_PASSWORD - PASSWORD - PS256_PRIVATE - PS256_PUBLIC - PS384_PRIVATE - PS384_PUBLIC - PS512_PRIVATE - PS512_PUBLIC - RS256_PRIVATE - RS256_PUBLIC - RS384_PRIVATE - RS384_PUBLIC - RS512_PRIVATE - RS512_PUBLIC - RSA - RSA_OAEP_256_PRIVATE - RSA_OAEP_256_PUBLIC - RSA_OAEP_384_PRIVATE - RSA_OAEP_384_PUBLIC - RSA_OAEP_512_PRIVATE - RSA_OAEP_512_PUBLIC - SSL_PKCS_12 type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array description: $ref: '#/components/schemas/DescriptionInStringBasedClientKeyCreateRequestBase' key: description: 'Key material as a string (encoded as ISO-8859-1 bytes). Required format depends on `algorithm`: symmetric (`HS256`, `HS384`, `HS512`, `A128KW`, `A192KW`, `A256KW`) — shared secret string; RSA/PS `*_PUBLIC` — PEM `BEGIN PUBLIC KEY` or DER-encoded X.509 SPKI; RSA/PS `*_PRIVATE` — PEM `BEGIN PRIVATE KEY` or PKCS#8 DER; EC `*_PRIVATE` — PEM EC private key; `PASSWORD` — plain password; `HTTP_BASIC` — `username:password`; `OAUTH*` — OAuth client secret string.' type: string name: $ref: '#/components/schemas/NameInStringBasedClientKeyCreateRequestBase' partner_key_id: description: External key identifier used to match tokens or credentials to this key (for example the JWT kid header). nullable: true type: string tags: description: Free-form tags used to filter active keys on list. items: type: string type: array type: description: Usage category that determines how the key is consumed at runtime. enum: - JWT - PASSWORD - PGP - PGP_EXTOLE - SSH - WEBHOOK type: string type: object NameInStringBasedClientKeyCreateRequestBase: description: Build-time expression that resolves to the display name for the key. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static name title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{name}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('name');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyUpdateRequestAsHs384: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - HS384 type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsHs384' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object DescriptionInOAuthGenericClientKeyUpdateRequest: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInGenericClientKeyUpdateRequestAsA192kw: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AuthorizationUrlInOAuthGenericClientKeyUpdateRequest: description: New build-time expression for the authorization endpoint URL. Omit to leave unchanged. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyResponseAsRsaOaep256Public: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - RSA_OAEP_256_PUBLIC type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object ClientKeyUpdateRequest: description: Body of a `PUT /v2/settings/security/keys/{key_id}` request. discriminator: mapping: A128KW: '#/components/schemas/GenericClientKeyUpdateRequestAsA128kw' A192KW: '#/components/schemas/GenericClientKeyUpdateRequestAsA192kw' A256KW: '#/components/schemas/GenericClientKeyUpdateRequestAsA256kw' ES256_PRIVATE: '#/components/schemas/GenericClientKeyUpdateRequestAsEs256Private' ES256_PUBLIC: '#/components/schemas/GenericClientKeyUpdateRequestAsEs256Public' ES384_PRIVATE: '#/components/schemas/GenericClientKeyUpdateRequestAsEs384Private' ES384_PUBLIC: '#/components/schemas/GenericClientKeyUpdateRequestAsEs384Public' ES512_PRIVATE: '#/components/schemas/GenericClientKeyUpdateRequestAsEs512Private' ES512_PUBLIC: '#/components/schemas/GenericClientKeyUpdateRequestAsEs512Public' HS256: '#/components/schemas/GenericClientKeyUpdateRequestAsHs256' HS384: '#/components/schemas/GenericClientKeyUpdateRequestAsHs384' HS512: '#/components/schemas/GenericClientKeyUpdateRequestAsHs512' HTTP_BASIC: '#/components/schemas/GenericClientKeyUpdateRequestAsHttpBasic' OAUTH: '#/components/schemas/OAuthClientKeyUpdateRequest' OAUTH_GENERIC: '#/components/schemas/OAuthGenericClientKeyUpdateRequest' OAUTH_LEAD_PERFECTION: '#/components/schemas/OAuthLeadPerfectionClientKeyUpdateRequest' OAUTH_LISTRAK: '#/components/schemas/OAuthListrakClientKeyUpdateRequest' OAUTH_OPTIMOVE: '#/components/schemas/OAuthOptimoveClientKeyUpdateRequest' OAUTH_SALESFORCE: '#/components/schemas/OAuthSalesforceClientKeyUpdateRequest' OAUTH_SFDC: '#/components/schemas/OAuthSfdcClientKeyUpdateRequest' OAUTH_SFDC_PASSWORD: '#/components/schemas/OAuthSfdcPasswordClientKeyUpdateRequest' PASSWORD: '#/components/schemas/GenericClientKeyUpdateRequestAsPassword' PS256_PRIVATE: '#/components/schemas/GenericClientKeyUpdateRequestAsPs256Private' PS256_PUBLIC: '#/components/schemas/GenericClientKeyUpdateRequestAsPs256Public' PS384_PRIVATE: '#/components/schemas/GenericClientKeyUpdateRequestAsPs384Private' PS384_PUBLIC: '#/components/schemas/GenericClientKeyUpdateRequestAsPs384Public' PS512_PRIVATE: '#/components/schemas/GenericClientKeyUpdateRequestAsPs512Private' PS512_PUBLIC: '#/components/schemas/GenericClientKeyUpdateRequestAsPs512Public' RS256_PRIVATE: '#/components/schemas/GenericClientKeyUpdateRequestAsRs256Private' RS256_PUBLIC: '#/components/schemas/GenericClientKeyUpdateRequestAsRs256Public' RS384_PRIVATE: '#/components/schemas/GenericClientKeyUpdateRequestAsRs384Private' RS384_PUBLIC: '#/components/schemas/GenericClientKeyUpdateRequestAsRs384Public' RS512_PRIVATE: '#/components/schemas/GenericClientKeyUpdateRequestAsRs512Private' RS512_PUBLIC: '#/components/schemas/GenericClientKeyUpdateRequestAsRs512Public' RSA: '#/components/schemas/GenericClientKeyUpdateRequestAsRsa' RSA_OAEP_256_PRIVATE: '#/components/schemas/GenericClientKeyUpdateRequestAsRsaOaep256Private' RSA_OAEP_256_PUBLIC: '#/components/schemas/GenericClientKeyUpdateRequestAsRsaOaep256Public' RSA_OAEP_384_PRIVATE: '#/components/schemas/GenericClientKeyUpdateRequestAsRsaOaep384Private' RSA_OAEP_384_PUBLIC: '#/components/schemas/GenericClientKeyUpdateRequestAsRsaOaep384Public' RSA_OAEP_512_PRIVATE: '#/components/schemas/GenericClientKeyUpdateRequestAsRsaOaep512Private' RSA_OAEP_512_PUBLIC: '#/components/schemas/GenericClientKeyUpdateRequestAsRsaOaep512Public' SSL_PKCS_12: '#/components/schemas/SslPkcs12ClientKeyUpdateRequest' propertyName: algorithm oneOf: - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsA128kw' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsA192kw' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsA256kw' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsEs256Private' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsEs256Public' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsEs384Private' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsEs384Public' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsEs512Private' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsEs512Public' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsHs256' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsHs384' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsHs512' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsHttpBasic' - $ref: '#/components/schemas/OAuthClientKeyUpdateRequest' - $ref: '#/components/schemas/OAuthGenericClientKeyUpdateRequest' - $ref: '#/components/schemas/OAuthLeadPerfectionClientKeyUpdateRequest' - $ref: '#/components/schemas/OAuthListrakClientKeyUpdateRequest' - $ref: '#/components/schemas/OAuthOptimoveClientKeyUpdateRequest' - $ref: '#/components/schemas/OAuthSalesforceClientKeyUpdateRequest' - $ref: '#/components/schemas/OAuthSfdcClientKeyUpdateRequest' - $ref: '#/components/schemas/OAuthSfdcPasswordClientKeyUpdateRequest' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsPassword' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsPs256Private' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsPs256Public' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsPs384Private' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsPs384Public' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsPs512Private' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsPs512Public' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsRs256Private' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsRs256Public' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsRs384Private' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsRs384Public' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsRs512Private' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsRs512Public' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsRsa' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsRsaOaep256Private' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsRsaOaep256Public' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsRsaOaep384Private' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsRsaOaep384Public' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsRsaOaep512Private' - $ref: '#/components/schemas/GenericClientKeyUpdateRequestAsRsaOaep512Public' - $ref: '#/components/schemas/SslPkcs12ClientKeyUpdateRequest' required: - algorithm DescriptionInOAuthLeadPerfectionClientKeyUpdateRequest: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyUpdateRequestAsPs256Private: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - PS256_PRIVATE type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsPs256Private' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object BuiltGenericClientKeyResponseAsHs512: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - HS512 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyCreateRequestAsRs512Private: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - RS512_PRIVATE type: string required: - algorithm - description - key - name - partner_key_id - type type: object AuthorizationUrlInOAuthLeadPerfectionClientKeyCreateRequest: description: Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInGenericClientKeyUpdateRequestAsHttpBasic: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AuthorizationUrlInOAuthSfdcClientKeyUpdateRequest: description: New build-time expression for the authorization endpoint URL. Omit to leave unchanged. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInGenericClientKeyUpdateRequestAsRsaOaep384Public: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInGenericClientKeyUpdateRequestAsRs384Private: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string OAuthOptimoveClientKeyUpdateRequest: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - OAUTH_OPTIMOVE type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthOptimoveClientKeyUpdateRequest' description: $ref: '#/components/schemas/DescriptionInOAuthOptimoveClientKeyUpdateRequest' key: description: Plain-text OAuth 2.0 client secret. Omit to leave unchanged. type: string oauth_client_id: description: New OAuth 2.0 client identifier. Omit to leave unchanged. type: string scope: description: New space-delimited OAuth scopes. Omit to leave unchanged. nullable: true type: string type: object required: - algorithm type: object BuiltGenericClientKeyResponseAsPs512: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - PS512 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object RequestInOAuthGenericClientKeyCreateRequest: description: Choose between static or dynamic request oneOf: - description: Static request properties: body: nullable: true type: string headers: additionalProperties: items: type: string type: array type: object url: type: string title: Static Value type: object - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{request}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('request');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [OAuthClientKeyRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts). example: handlebars@runtime:{{request}} externalDocs: description: OAuthClientKeyRuntimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [OAuthClientKeyRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts). example: javascript@runtime:function() { return context.get('request');} externalDocs: description: OAuthClientKeyRuntimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string GenericClientKeyCreateRequestAsHttpBasic: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - HTTP_BASIC type: string required: - algorithm - description - key - name - partner_key_id - type type: object DescriptionInGenericClientKeyUpdateRequestAsRs512Public: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string NameInClientKeyUpdateRequestBase: description: New build-time expression for the display name. Omit to leave unchanged. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static name title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{name}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('name');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string AuthorizationUrlInOAuthClientKeyCreateRequest: description: Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyUpdateRequestAsRsaOaep256Private: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - RSA_OAEP_256_PRIVATE type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsRsaOaep256Private' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object AuthorizationUrlInOAuthSfdcPasswordClientKeyResponse: description: OAuth 2.0 authorization endpoint URL, in build-time evaluatable form. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string BuiltGenericClientKeyResponseAsRsa: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - RSA type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyResponseAsRsaOaep384Public: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - RSA_OAEP_384_PUBLIC type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyResponseAsRsa: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - RSA type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyCreateRequestAsHs256: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - HS256 type: string required: - algorithm - description - key - name - partner_key_id - type type: object BuiltGenericClientKeyResponseAsPs256: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - PS256 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object OAuthSfdcPasswordClientKeyUpdateRequest: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - OAUTH_SFDC_PASSWORD type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthSfdcPasswordClientKeyUpdateRequest' description: $ref: '#/components/schemas/DescriptionInOAuthSfdcPasswordClientKeyUpdateRequest' key: description: Plain-text OAuth 2.0 client secret. Omit to leave unchanged. type: string oauth_client_id: description: New OAuth 2.0 client identifier. Omit to leave unchanged. type: string scope: description: New space-delimited OAuth scopes. Omit to leave unchanged. nullable: true type: string type: object required: - algorithm type: object RequestInBuiltOAuthGenericClientKeyResponse: description: 'The request as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal request properties: body: nullable: true type: string headers: additionalProperties: items: type: string type: array type: object url: type: string title: Static Value type: object - description: Handlebars expression with [OAuthClientKeyRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts). example: handlebars@runtime:{{request}} externalDocs: description: OAuthClientKeyRuntimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [OAuthClientKeyRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts). example: javascript@runtime:function() { return context.get('request');} externalDocs: description: OAuthClientKeyRuntimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string GenericClientKeyCreateRequestAsRsaOaep512Private: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - RSA_OAEP_512_PRIVATE type: string required: - algorithm - description - key - name - partner_key_id - type type: object BuiltGenericClientKeyResponseAsEs384: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - ES384 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object DescriptionInGenericClientKeyUpdateRequestAsRsaOaep256Public: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyUpdateRequestAsPs384Public: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - PS384_PUBLIC type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsPs384Public' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object ClientKeyResponseBase: properties: algorithm: description: Cryptographic or integration algorithm. Discriminator for polymorphic create, update, and response schemas. enum: - A128KW - A192KW - A256KW - ES256_PRIVATE - ES256_PUBLIC - ES384_PRIVATE - ES384_PUBLIC - ES512_PRIVATE - ES512_PUBLIC - GENERIC - HS256 - HS384 - HS512 - HTTP_BASIC - OAUTH - OAUTH_GENERIC - OAUTH_LEAD_PERFECTION - OAUTH_LISTRAK - OAUTH_OPTIMOVE - OAUTH_SALESFORCE - OAUTH_SFDC - OAUTH_SFDC_PASSWORD - PASSWORD - PS256_PRIVATE - PS256_PUBLIC - PS384_PRIVATE - PS384_PUBLIC - PS512_PRIVATE - PS512_PUBLIC - RS256_PRIVATE - RS256_PUBLIC - RS384_PRIVATE - RS384_PUBLIC - RS512_PRIVATE - RS512_PUBLIC - RSA - RSA_OAEP_256_PRIVATE - RSA_OAEP_256_PUBLIC - RSA_OAEP_384_PRIVATE - RSA_OAEP_384_PUBLIC - RSA_OAEP_512_PRIVATE - RSA_OAEP_512_PUBLIC - SSL_PKCS_12 type: string component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array created_at: $ref: '#/components/schemas/ZonedDateTime' description: $ref: '#/components/schemas/DescriptionInClientKeyResponseBase' id: description: Stable Extole identifier for the client key. readOnly: true type: string key: description: Key material in the same encoding accepted on create. Symmetric secrets and private keys are partially masked in API responses; public keys are returned in full PEM form. type: string name: $ref: '#/components/schemas/NameInClientKeyResponseBase' partner_key_id: description: External key identifier used to match tokens or credentials to this key (for example the JWT kid header). type: string tags: description: Free-form tags applied to the client key. items: type: string type: array type: description: Usage category that determines how the key is consumed at runtime. enum: - JWT - PASSWORD - PGP - PGP_EXTOLE - SSH - WEBHOOK type: string updated_at: $ref: '#/components/schemas/ZonedDateTime' type: object DescriptionInGenericClientKeyUpdateRequestAsRsaOaep256Private: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInClientKeyUpdateRequestBase: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RequestInOAuthGenericClientKeyResponse: description: 'The request as configured: a literal value, or an expression (type:string) when defined dynamically.' oneOf: - description: Literal request properties: body: nullable: true type: string headers: additionalProperties: items: type: string type: array type: object url: type: string title: Static Value type: object - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{request}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('request');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [OAuthClientKeyRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts). example: handlebars@runtime:{{request}} externalDocs: description: OAuthClientKeyRuntimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [OAuthClientKeyRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts). example: javascript@runtime:function() { return context.get('request');} externalDocs: description: OAuthClientKeyRuntimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string AuthorizationUrlInOAuthSfdcPasswordClientKeyCreateRequest: description: Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyCreateRequestAsEs256Private: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - ES256_PRIVATE type: string required: - algorithm - description - key - name - partner_key_id - type type: object DescriptionInGenericClientKeyUpdateRequestAsA256kw: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ZonedDateTime: description: '[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.' example: '2025-10-24T02:00:00-07:00' pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$ type: string GenericClientKeyUpdateRequestAsHs512: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - HS512 type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsHs512' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object AuthorizationUrlInOAuthSalesforceClientKeyResponse: description: OAuth 2.0 authorization endpoint URL, in build-time evaluatable form. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal authorization url title: Static Value - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{authorizationUrl}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('authorizationUrl');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ResponseHandlerInOAuthGenericClientKeyCreateRequest: description: Choose between static or dynamic response handler oneOf: - description: Static response handler properties: accessToken: type: string expiresIn: format: int64 type: integer title: Static Value type: object - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{responseHandler}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('responseHandler');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [OAuthClientKeyResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts). example: handlebars@runtime:{{responseHandler}} externalDocs: description: OAuthClientKeyResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [OAuthClientKeyResponseContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts). example: javascript@runtime:function() { return context.get('responseHandler');} externalDocs: description: OAuthClientKeyResponseContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/response/OAuthClientKeyResponseContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string RequestInOAuthGenericClientKeyUpdateRequest: description: Choose between static or dynamic request oneOf: - description: Static request properties: body: nullable: true type: string headers: additionalProperties: items: type: string type: array type: object url: type: string title: Static Value type: object - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{request}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('request');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string - description: Handlebars expression with [OAuthClientKeyRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts). example: handlebars@runtime:{{request}} externalDocs: description: OAuthClientKeyRuntimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: Javascript expression with [OAuthClientKeyRuntimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts). example: javascript@runtime:function() { return context.get('request');} externalDocs: description: OAuthClientKeyRuntimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/OAuthClientKeyRuntimeContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string BuiltGenericClientKeyResponseAsHs256: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - HS256 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyResponseAsHttpBasic: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - HTTP_BASIC type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyUpdateRequestAsPassword: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - PASSWORD type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsPassword' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object DescriptionInGenericClientKeyUpdateRequestAsRs256Public: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyResponseAsEs256Private: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - ES256_PRIVATE type: string id: description: Stable Extole identifier for the client key. readOnly: true type: string type: object description: Stored generic client key definition. Fields `name` and `description` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyCreateRequestAsRs256Private: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - RS256_PRIVATE type: string required: - algorithm - description - key - name - partner_key_id - type type: object DescriptionInGenericClientKeyUpdateRequestAsRs384Public: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyCreateRequestAsHs384: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - HS384 type: string required: - algorithm - description - key - name - partner_key_id - type type: object DescriptionInGenericClientKeyUpdateRequestAsEs384Private: description: New build-time expression for the description. Omit to leave unchanged. oneOf: - description: Static description nullable: true title: Static Value type: string - description: Handlebars expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: Javascript expression with [ClientKeyBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts). example: javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: ClientKeyBuildtimeContext url: https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/client/security/key/built/ClientKeyBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string GenericClientKeyCreateRequestAsRsaOaep256Private: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - RSA_OAEP_256_PRIVATE type: string required: - algorithm - description - key - name - partner_key_id - type type: object GenericClientKeyUpdateRequestAsEs512Private: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - ES512_PRIVATE type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsEs512Private' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object BuiltGenericClientKeyResponseAsHttpBasic: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - HTTP_BASIC type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object GenericClientKeyCreateRequestAsRs512Public: allOf: - $ref: '#/components/schemas/StringBasedClientKeyCreateRequestBase' - properties: algorithm: enum: - RS512_PUBLIC type: string required: - algorithm - description - key - name - partner_key_id - type type: object GenericClientKeyUpdateRequestAsA192kw: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - A192KW type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsA192kw' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object GenericClientKeyUpdateRequestAsEs256Public: allOf: - $ref: '#/components/schemas/ClientKeyUpdateRequestBase' - properties: algorithm: enum: - ES256_PUBLIC type: string description: $ref: '#/components/schemas/DescriptionInGenericClientKeyUpdateRequestAsEs256Public' key: description: New key material in the same format as `key` on create for this `algorithm`. Omit to leave unchanged. type: string type: object required: - algorithm type: object OAuthListrakClientKeyResponse: allOf: - $ref: '#/components/schemas/ClientKeyResponseBase' - properties: algorithm: enum: - OAUTH_LISTRAK type: string authorization_url: $ref: '#/components/schemas/AuthorizationUrlInOAuthListrakClientKeyResponse' id: description: Stable Extole identifier for the client key. readOnly: true type: string oauth_client_id: description: OAuth 2.0 client identifier registered with the authorization server. type: string scope: description: Space-delimited OAuth scopes requested during authorization. nullable: true type: string type: object description: Stored oauth listrak client key definition. Fields `name`, `description`, and `authorization_url` are unevaluated and appear in buildtime-evaluatable form. required: - algorithm - authorization_url - component_ids - component_references - created_at - description - id - key - name - oauth_client_id - partner_key_id - scope - tags - type - updated_at type: object BuiltGenericClientKeyResponseAsRsaOaep384: allOf: - $ref: '#/components/schemas/BuiltClientKeyResponseBase' - properties: algorithm: enum: - RSA_OAEP_384 type: string id: readOnly: true type: string type: object description: generic client key after buildtime evaluation. Fields `name` and `description` are already evaluated. required: - algorithm - component_ids - component_references - created_at - description - id - key - name - partner_key_id - tags - type - updated_at type: object examples: oauth_client_id_too_long: summary: oauth_client_id_too_long value: code: oauth_client_id_too_long http_status_code: 400 message: OAuth client id is too long parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_associated_with_entity: summary: client_key_associated_with_entity value: code: client_key_associated_with_entity http_status_code: 400 message: Can't delete a client key associated with an entity parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_duplicate_partner_key_id: summary: client_key_duplicate_partner_key_id value: code: client_key_duplicate_partner_key_id http_status_code: 400 message: Key with such partner key id already defined parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 circular_component_reference: summary: circular_component_reference value: code: circular_component_reference http_status_code: 400 message: Circular campaign component reference is not allowed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_facets_not_found: summary: component_facets_not_found value: code: component_facets_not_found http_status_code: 400 message: Component facets not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_lead_perfection_client_id: summary: missing_lead_perfection_client_id value: code: missing_lead_perfection_client_id http_status_code: 400 message: Missing lead perfection client id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 excessive_component_reference: summary: excessive_component_reference value: code: excessive_component_reference http_status_code: 400 message: Root campaign component may have at most one reference parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_json: summary: invalid_json value: code: invalid_json http_status_code: 400 message: JSON is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 authorization_url_invalid: summary: authorization_url_invalid value: code: authorization_url_invalid http_status_code: 400 message: Authorization URL must be a valid HTTPS URL parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 scope_too_long: summary: scope_too_long value: code: scope_too_long http_status_code: 400 message: Scope is too long parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_account_id: summary: invalid_account_id value: code: invalid_account_id http_status_code: 400 message: Account id should be a positive number parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_missing: summary: client_key_missing value: code: client_key_missing http_status_code: 400 message: Key value is not specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_description_out_of_range: summary: campaign_component_description_out_of_range value: code: campaign_component_description_out_of_range http_status_code: 400 message: Campaign component description length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_display_name_contains_illegal_character: summary: campaign_component_display_name_contains_illegal_character value: code: campaign_component_display_name_contains_illegal_character http_status_code: 400 message: Campaign component display name can only contain alphanumeric, dash, underscore, whitespace, asterisk, hash, dollar characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_invalid_partner_key_id: summary: client_key_invalid_partner_key_id value: code: client_key_invalid_partner_key_id http_status_code: 400 message: Partner key id should be up to 240 characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_parameter: summary: invalid_parameter value: code: invalid_parameter http_status_code: 400 message: Parameter is invalid. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_display_name_out_of_range: summary: campaign_component_display_name_out_of_range value: code: campaign_component_display_name_out_of_range http_status_code: 400 message: Campaign component display name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_reference_socket_name: summary: invalid_component_reference_socket_name value: code: invalid_component_reference_socket_name http_status_code: 400 message: Invalid component reference socket name parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_authorization_url: summary: missing_authorization_url value: code: missing_authorization_url http_status_code: 400 message: Authorization URL is not specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_build_failed: summary: client_key_build_failed value: code: client_key_build_failed http_status_code: 400 message: Client key build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_out_of_range: summary: campaign_component_name_out_of_range value: code: campaign_component_name_out_of_range http_status_code: 400 message: Campaign component name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_reference: summary: invalid_component_reference value: code: invalid_component_reference http_status_code: 400 message: Unknown referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 pgp_extole_client_key_not_found: summary: pgp_extole_client_key_not_found value: code: pgp_extole_client_key_not_found http_status_code: 400 message: PGP Extole key is not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_type_validation_failed: summary: campaign_component_type_validation_failed value: code: campaign_component_type_validation_failed http_status_code: 400 message: Campaign component type validation failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 authorization_url_invalid_uri: summary: authorization_url_invalid_uri value: code: authorization_url_invalid_uri http_status_code: 400 message: Authorization URL is an invalid URI parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 authorization_url_too_long: summary: authorization_url_too_long value: code: authorization_url_too_long http_status_code: 400 message: Authorization URL is too long parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_missing_type: summary: client_key_missing_type value: code: client_key_missing_type http_status_code: 400 message: Key type is not specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_oauth_client_id: summary: missing_oauth_client_id value: code: missing_oauth_client_id http_status_code: 400 message: OAuth client id is not specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_invalid_description: summary: client_key_invalid_description value: code: client_key_invalid_description http_status_code: 400 message: Allowed description length is 1024 containing ASCII characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_invalid_name: summary: client_key_invalid_name value: code: client_key_invalid_name http_status_code: 400 message: Allowed name length is 255 containing ASCII characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 binding_error: summary: binding_error value: code: binding_error http_status_code: 400 message: Argument is not of the expected type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_id_missing: summary: campaign_component_id_missing value: code: campaign_component_id_missing http_status_code: 400 message: Campaign component id is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_app_key: summary: missing_app_key value: code: missing_app_key http_status_code: 400 message: Missing app key parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_external_component_reference: summary: invalid_external_component_reference value: code: invalid_external_component_reference http_status_code: 400 message: Unknown external referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_missing_algorithm: summary: client_key_missing_algorithm value: code: client_key_missing_algorithm http_status_code: 400 message: Key algorithm is not specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_not_found: summary: client_key_not_found value: code: client_key_not_found http_status_code: 400 message: Key is not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_too_long: summary: client_key_too_long value: code: client_key_too_long http_status_code: 400 message: Key does not satisfy max length requirement for the associated algorithm parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 external_elements_cannot_have_multiple_references: summary: external_elements_cannot_have_multiple_references value: code: external_elements_cannot_have_multiple_references http_status_code: 400 message: External elements cannot have multiple references parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_too_short: summary: client_key_too_short value: code: client_key_too_short http_status_code: 400 message: Key does not satisfy min length requirement for the associated algorithm parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 jwt_missing: summary: jwt_missing value: code: jwt_missing http_status_code: 400 message: No JWT specified for verification parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_unsupported_type: summary: client_key_unsupported_type value: code: client_key_unsupported_type http_status_code: 400 message: Key type is not supported for this algorithm parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_invalid: summary: client_key_invalid value: code: client_key_invalid http_status_code: 400 message: Invalid key parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_request_body: summary: missing_request_body value: code: missing_request_body http_status_code: 400 message: Missing request body parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_invalid_tag: summary: client_key_invalid_tag value: code: client_key_invalid_tag http_status_code: 400 message: Invalid client key tag parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_username: summary: missing_username value: code: missing_username http_status_code: 400 message: Missing username parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 redundant_component_reference: summary: redundant_component_reference value: code: redundant_component_reference http_status_code: 400 message: Same reference defined multiple times parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_missing_name: summary: client_key_missing_name value: code: client_key_missing_name http_status_code: 400 message: Key required name is not specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 self_component_reference: summary: self_component_reference value: code: self_component_reference http_status_code: 400 message: Self campaign component reference is not allowed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 external_element_in_use: summary: external_element_in_use value: code: external_element_in_use http_status_code: 400 message: External element is in use parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 orphan_external_component_reference: summary: orphan_external_component_reference value: code: orphan_external_component_reference http_status_code: 400 message: Orphan external referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_installed_into_socket: summary: invalid_component_installed_into_socket value: code: invalid_component_installed_into_socket http_status_code: 400 message: Invalid component installed into socket parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_contains_illegal_character: summary: campaign_component_name_contains_illegal_character value: code: campaign_component_name_contains_illegal_character http_status_code: 400 message: Campaign component name can only contain alphanumeric, dash and underscore characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_password: summary: missing_password value: code: missing_password http_status_code: 400 message: Missing password parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 external_element_is_referenced_by_active_configuration: summary: external_element_is_referenced_by_active_configuration value: code: external_element_is_referenced_by_active_configuration http_status_code: 400 message: External element is referenced by active configuration parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_already_in_use: summary: campaign_component_name_already_in_use value: code: campaign_component_name_already_in_use http_status_code: 400 message: Campaign component name is already used by another component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_absolute_name_missing: summary: campaign_component_absolute_name_missing value: code: campaign_component_absolute_name_missing http_status_code: 400 message: Campaign component absolute name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: COOKIE: in: cookie name: extole_token type: apiKey HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey x-tagGroups: - name: Integration API - Consumer to Extole tags: - Authentication - Content - Email - Events - Persons - Profile Assets - Profiles