Extole Security Keys API
The Security Keys API from Extole — 6 operation(s) for security keys.
Extole Security Keys API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Security Keys. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 8 operations across 6 paths, and defines 249 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://{brand}.extole.io.
8 operations
6 paths
249 schemas
1 DELETE2 GET4 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Extole Security Keys API declares
3 security schemes
for authenticating requests.
An API key is passed in the cookie as extole_token (COOKIE).
An API key is passed in the header as Authorization (HEADER).
An API key is passed in the query as access_token (QUERY).
By default, every request must be authenticated.
Paths & Operations 8
Across 6 paths, the API surfaces 8 operations — 1 DELETE, 2 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Security Keys 8
POST
/v2/settings/security/keys/jwt/{key_id}/verify-jwtdeprecated
Verify JWT client key
GET
/v2/settings/security/keys
List client keys
POST
/v2/settings/security/keys
Create client key
GET
/v2/settings/security/keys/built
List built client keys
POST
/v2/settings/security/keys/{key_id}/delete
Delete client key
POST
/v2/settings/security/keys/{key_id}/unarchive
Unarchive client key
PUT
/v2/settings/security/keys/{key_id}
Update client key
DELETE
/v2/settings/security/keys/{key_id}
Archive client key
Schemas 249
The contract defines 249 schemas that model the data the API accepts and returns. The most detailed are BuiltClientKeyResponseBase (12 properties), ClientKeyResponseBase (12 properties), StringBasedClientKeyCreateRequestBase (9 properties), ClientKeyUpdateRequestBase (6 properties). Each schema is shown below with its type and property counts.
OAuthListrakClientKeyCreateRequest
object
9 required
GenericClientKeyCreateRequestAsEs256Public
object
6 required
GenericClientKeyResponseAsHs256
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
ClientKeyUpdateRequestBase
object
6 properties
AuthorizationUrlInOAuthListrakClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsPassword
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyResponseAsA192kw
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyResponseAsPs256Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
OAuthOptimoveClientKeyCreateRequest
object
9 required
DescriptionInGenericClientKeyUpdateRequestAsA128kw
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsEs384Public
object
1 required
GenericClientKeyCreateRequestAsPs384Private
object
6 required
DescriptionInOAuthSalesforceClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyCreateRequestAsPs256Private
object
6 required
GenericClientKeyResponseAsPs256Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyResponseAsEs384Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
OAuthSalesforceClientKeyCreateRequest
object
10 required
BuiltGenericClientKeyResponseAsA192kw
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyUpdateRequestAsEs384Private
object
1 required
GenericClientKeyCreateRequestAsEs384Public
object
6 required
DescriptionInGenericClientKeyUpdateRequestAsRs256Private
New build-time expression for the description. Omit to leave unchanged.
AuthorizationUrlInOAuthSfdcPasswordClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
GenericClientKeyResponseAsRsaOaep384Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyResponseAsRs512Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyCreateRequestAsRsaOaep256Public
object
6 required
AuthorizationUrlInOAuthLeadPerfectionClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
DescriptionInOAuthOptimoveClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyCreateRequestAsPassword
object
6 required
AuthorizationUrlInOAuthSfdcClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
OAuthGenericClientKeyCreateRequest
object
9 required
GenericClientKeyUpdateRequestAsPs512Public
object
1 required
AuthorizationUrlInOAuthListrakClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
DescriptionInGenericClientKeyUpdateRequestAsRs512Private
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyCreateRequestAsRsaOaep384Private
object
6 required
GenericClientKeyCreateRequestAsEs512Public
object
6 required
DescriptionInGenericClientKeyUpdateRequestAsPs384Private
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyResponseAsHs384
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
OAuthSfdcPasswordClientKeyResponse
object
Stored oauth sfdc password client key definition. Fields name, description, and authorizationurl are unevaluated and appear in buildtime-evaluatable form.
17 required
GenericClientKeyCreateRequestAsRs256Public
object
6 required
GenericClientKeyUpdateRequestAsRs384Private
object
1 required
DescriptionInGenericClientKeyUpdateRequestAsPs512Public
New build-time expression for the description. Omit to leave unchanged.
BuiltGenericClientKeyResponseAsRsaOaep256
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyResponseAsRs384Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
DescriptionInOAuthSfdcClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
AuthorizationUrlInOAuthGenericClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
DescriptionInGenericClientKeyUpdateRequestAsEs256Public
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyResponseAsRsaOaep512Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
DescriptionInOAuthClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyCreateRequestAsEs384Private
object
6 required
DescriptionInGenericClientKeyUpdateRequestAsPs256Private
New build-time expression for the description. Omit to leave unchanged.
ComponentReferenceResponse
object
2 properties
GenericClientKeyUpdateRequestAsRs384Public
object
1 required
ResponseHandlerInOAuthGenericClientKeyResponse
The response handler as configured: a literal value, or an expression (type:string) when defined dynamically.
DescriptionInGenericClientKeyUpdateRequestAsPs256Public
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyResponseAsEs512Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
DescriptionInGenericClientKeyUpdateRequestAsHs512
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyResponseAsRs384Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
JwtClientKeyVerifyJwtResponse
object
2 properties
2 required
DescriptionInGenericClientKeyUpdateRequestAsRsaOaep512Public
New build-time expression for the description. Omit to leave unchanged.
DescriptionInOAuthListrakClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsRsa
New build-time expression for the description. Omit to leave unchanged.
OAuthSalesforceClientKeyUpdateRequest
object
1 required
OAuthSfdcClientKeyResponse
object
Stored oauth sfdc client key definition. Fields name, description, and authorizationurl are unevaluated and appear in buildtime-evaluatable form.
15 required
GenericClientKeyUpdateRequestAsRs512Private
object
1 required
BuiltOAuthSfdcClientKeyResponse
object
15 required
OAuthGenericClientKeyUpdateRequest
object
1 required
AuthorizationUrlInOAuthClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
BuiltGenericClientKeyResponseAsRs384
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyUpdateRequestAsPs256Public
object
1 required
OAuthClientKeyResponse
object
Stored oauth client key definition. Fields name, description, and authorizationurl are unevaluated and appear in buildtime-evaluatable form.
15 required
GenericClientKeyUpdateRequestAsEs256Private
object
1 required
BuiltGenericClientKeyResponseAsRs512
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyResponseAsRsaOaep512Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyResponseAsA256kw
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyCreateRequestAsRs384Public
object
6 required
GenericClientKeyResponseAsRs256Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
BuiltGenericClientKeyResponseAsEs512
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyCreateRequestAsEs512Private
object
6 required
AuthorizationUrlInOAuthOptimoveClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
GenericClientKeyCreateRequestAsA128kw
object
6 required
GenericClientKeyCreateRequestAsRsaOaep384Public
object
6 required
SslPkcs12ClientKeyResponse
object
Stored ssl pkcs12client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
13 required
GenericClientKeyResponseAsRs512Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyResponseAsEs256Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
BuiltOAuthLeadPerfectionClientKeyResponse
object
17 required
GenericClientKeyResponseAsHs512
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyUpdateRequestAsHs256
object
1 required
BuiltClientKeyResponse
client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyUpdateRequestAsRs256Private
object
1 required
OAuthLeadPerfectionClientKeyResponse
object
Stored oauth lead perfection client key definition. Fields name, description, and authorizationurl are unevaluated and appear in buildtime-evaluatable form.
17 required
GenericClientKeyResponseAsPs384Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyResponseAsPs512Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
DescriptionInGenericClientKeyUpdateRequestAsEs384Public
New build-time expression for the description. Omit to leave unchanged.
SslPkcs12ClientKeyUpdateRequest
object
1 required
BuiltOAuthSalesforceClientKeyResponse
object
16 required
BuiltGenericClientKeyResponseAsRs256
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyUpdateRequestAsRsaOaep384Public
object
1 required
GenericClientKeyCreateRequestAsPs384Public
object
6 required
GenericClientKeyResponseAsPs512Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
OAuthSfdcClientKeyUpdateRequest
object
1 required
ResponseHandlerInOAuthGenericClientKeyUpdateRequest
Choose between static or dynamic response handler
OAuthGenericClientKeyResponse
object
Stored oauth generic client key definition. Fields name, description, authorizationurl, request, and responsehandler are unevaluated and appear in buildtime-ev…
17 required
NameInClientKeyResponseBase
Display name for the key, in the same build-time evaluatable form that was supplied on create or update.
JwtClientKeyVerifyJwtRequest
object
1 property
1 required
OAuthClientKeyUpdateRequest
object
1 required
GenericClientKeyUpdateRequestAsRsaOaep512Public
object
1 required
OAuthSfdcClientKeyCreateRequest
object
9 required
BuiltClientKeyResponseBase
object
12 properties
DescriptionInGenericClientKeyUpdateRequestAsPs384Public
New build-time expression for the description. Omit to leave unchanged.
BuiltOAuthSfdcPasswordClientKeyResponse
object
17 required
DescriptionInGenericClientKeyUpdateRequestAsEs256Private
New build-time expression for the description. Omit to leave unchanged.
AuthorizationUrlInOAuthSalesforceClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
AuthorizationUrlInOAuthClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
GenericClientKeyCreateRequestAsRs384Private
object
6 required
OAuthOptimoveClientKeyResponse
object
Stored oauth optimove client key definition. Fields name, description, and authorizationurl are unevaluated and appear in buildtime-evaluatable form.
15 required
BuiltGenericClientKeyResponseAsA256kw
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyUpdateRequestAsRsaOaep256Public
object
1 required
AuthorizationUrlInOAuthOptimoveClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
GenericClientKeyResponseAsRsaOaep256Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
OAuthLeadPerfectionClientKeyUpdateRequest
object
1 required
OAuthClientKeyCreateRequest
object
9 required
GenericClientKeyUpdateRequestAsRs256Public
object
1 required
GenericClientKeyResponseAsA128kw
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
DescriptionInGenericClientKeyUpdateRequestAsEs512Public
New build-time expression for the description. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsRsaOaep384Private
New build-time expression for the description. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsRsaOaep512Private
New build-time expression for the description. Omit to leave unchanged.
OAuthSalesforceClientKeyResponse
object
Stored oauth salesforce client key definition. Fields name, description, and authorizationurl are unevaluated and appear in buildtime-evaluatable form.
16 required
DescriptionInGenericClientKeyUpdateRequestAsPs512Private
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyResponseAsPs384Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
AuthorizationUrlInOAuthOptimoveClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
AuthorizationUrlInOAuthSalesforceClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsPs384Private
object
1 required
GenericClientKeyCreateRequestAsPs512Private
object
6 required
GenericClientKeyUpdateRequestAsA256kw
object
1 required
AuthorizationUrlInOAuthLeadPerfectionClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsEs512Public
object
1 required
DescriptionInStringBasedClientKeyCreateRequestBase
Optional build-time expression that resolves to a human-readable description.
GenericClientKeyResponseAsEs512Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyCreateRequestAsPs256Public
object
6 required
GenericClientKeyUpdateRequestAsRs512Public
object
1 required
BuiltGenericClientKeyResponseAsEs256
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
BuiltGenericClientKeyResponseAsPs384
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
ClientKeyResponse
12 required
GenericClientKeyResponseAsPassword
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
BuiltOAuthGenericClientKeyResponse
object
17 required
GenericClientKeyResponseAsRs256Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyResponseAsEs384Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyCreateRequestAsRsaOaep512Public
object
6 required
DescriptionInGenericClientKeyUpdateRequestAsHs256
New build-time expression for the description. Omit to leave unchanged.
AuthorizationUrlInOAuthSfdcClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
BuiltGenericClientKeyResponseAsA128kw
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
DescriptionInGenericClientKeyUpdateRequestAsHs384
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyCreateRequestAsA256kw
object
6 required
BuiltGenericClientKeyResponseAsRsaOaep512
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyCreateRequestAsA192kw
object
6 required
GenericClientKeyUpdateRequestAsA128kw
object
1 required
BuiltGenericClientKeyResponseAsHs384
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
BuiltOAuthListrakClientKeyResponse
object
15 required
BuiltSslPkcs12ClientKeyResponse
object
ssl pkcs12client key after buildtime evaluation. Fields name and description are already evaluated.
13 required
StringBasedClientKeyCreateRequest
Body of a POST /v2/settings/security/keys request.
6 required
GenericClientKeyCreateRequestAsRsa
object
6 required
OAuthLeadPerfectionClientKeyCreateRequest
object
9 required
BuiltOAuthClientKeyResponse
object
15 required
AuthorizationUrlInOAuthGenericClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
GenericClientKeyCreateRequestAsHs512
object
6 required
OAuthSfdcPasswordClientKeyCreateRequest
object
11 required
RestExceptionResponse
object
Represents the API error response
5 properties
5 required
GenericClientKeyUpdateRequestAsPs512Private
object
1 required
AuthorizationUrlInOAuthListrakClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
DescriptionInClientKeyResponseBase
Optional build-time expression that resolves to a human-readable description.
ComponentReferenceRequest
object
2 properties
BuiltGenericClientKeyResponseAsPassword
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyUpdateRequestAsRsa
object
1 required
OAuthListrakClientKeyUpdateRequest
object
1 required
BuiltOAuthOptimoveClientKeyResponse
object
15 required
GenericClientKeyCreateRequestAsPs512Public
object
6 required
DescriptionInGenericClientKeyUpdateRequestAsEs512Private
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsRsaOaep384Private
object
1 required
DescriptionInSslPkcs12ClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
ResponseHandlerInBuiltOAuthGenericClientKeyResponse
The response handler as configured: a literal value, or an expression (type:string) when defined dynamically.
GenericClientKeyUpdateRequestAsHttpBasic
object
1 required
GenericClientKeyUpdateRequestAsRsaOaep512Private
object
1 required
DescriptionInOAuthSfdcPasswordClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
StringBasedClientKeyCreateRequestBase
object
9 properties
NameInStringBasedClientKeyCreateRequestBase
Build-time expression that resolves to the display name for the key.
GenericClientKeyUpdateRequestAsHs384
object
1 required
DescriptionInOAuthGenericClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsA192kw
New build-time expression for the description. Omit to leave unchanged.
AuthorizationUrlInOAuthGenericClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
GenericClientKeyResponseAsRsaOaep256Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
ClientKeyUpdateRequest
Body of a PUT /v2/settings/security/keys/{keyid} request.
1 required
DescriptionInOAuthLeadPerfectionClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsPs256Private
object
1 required
BuiltGenericClientKeyResponseAsHs512
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyCreateRequestAsRs512Private
object
6 required
AuthorizationUrlInOAuthLeadPerfectionClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
DescriptionInGenericClientKeyUpdateRequestAsHttpBasic
New build-time expression for the description. Omit to leave unchanged.
AuthorizationUrlInOAuthSfdcClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsRsaOaep384Public
New build-time expression for the description. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsRs384Private
New build-time expression for the description. Omit to leave unchanged.
OAuthOptimoveClientKeyUpdateRequest
object
1 required
BuiltGenericClientKeyResponseAsPs512
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
RequestInOAuthGenericClientKeyCreateRequest
Choose between static or dynamic request
GenericClientKeyCreateRequestAsHttpBasic
object
6 required
DescriptionInGenericClientKeyUpdateRequestAsRs512Public
New build-time expression for the description. Omit to leave unchanged.
NameInClientKeyUpdateRequestBase
New build-time expression for the display name. Omit to leave unchanged.
AuthorizationUrlInOAuthClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
GenericClientKeyUpdateRequestAsRsaOaep256Private
object
1 required
AuthorizationUrlInOAuthSfdcPasswordClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
BuiltGenericClientKeyResponseAsRsa
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyResponseAsRsaOaep384Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyResponseAsRsa
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyCreateRequestAsHs256
object
6 required
BuiltGenericClientKeyResponseAsPs256
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
OAuthSfdcPasswordClientKeyUpdateRequest
object
1 required
RequestInBuiltOAuthGenericClientKeyResponse
The request as configured: a literal value, or an expression (type:string) when defined dynamically.
GenericClientKeyCreateRequestAsRsaOaep512Private
object
6 required
BuiltGenericClientKeyResponseAsEs384
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
DescriptionInGenericClientKeyUpdateRequestAsRsaOaep256Public
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsPs384Public
object
1 required
ClientKeyResponseBase
object
12 properties
DescriptionInGenericClientKeyUpdateRequestAsRsaOaep256Private
New build-time expression for the description. Omit to leave unchanged.
DescriptionInClientKeyUpdateRequestBase
New build-time expression for the description. Omit to leave unchanged.
RequestInOAuthGenericClientKeyResponse
The request as configured: a literal value, or an expression (type:string) when defined dynamically.
AuthorizationUrlInOAuthSfdcPasswordClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
GenericClientKeyCreateRequestAsEs256Private
object
6 required
DescriptionInGenericClientKeyUpdateRequestAsA256kw
New build-time expression for the description. Omit to leave unchanged.
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…
GenericClientKeyUpdateRequestAsHs512
object
1 required
AuthorizationUrlInOAuthSalesforceClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
ResponseHandlerInOAuthGenericClientKeyCreateRequest
Choose between static or dynamic response handler
RequestInOAuthGenericClientKeyUpdateRequest
Choose between static or dynamic request
BuiltGenericClientKeyResponseAsHs256
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyResponseAsHttpBasic
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyUpdateRequestAsPassword
object
1 required
DescriptionInGenericClientKeyUpdateRequestAsRs256Public
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyResponseAsEs256Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyCreateRequestAsRs256Private
object
6 required
DescriptionInGenericClientKeyUpdateRequestAsRs384Public
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyCreateRequestAsHs384
object
6 required
DescriptionInGenericClientKeyUpdateRequestAsEs384Private
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyCreateRequestAsRsaOaep256Private
object
6 required
GenericClientKeyUpdateRequestAsEs512Private
object
1 required
BuiltGenericClientKeyResponseAsHttpBasic
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyCreateRequestAsRs512Public
object
6 required
GenericClientKeyUpdateRequestAsA192kw
object
1 required
GenericClientKeyUpdateRequestAsEs256Public
object
1 required
OAuthListrakClientKeyResponse
object
Stored oauth listrak client key definition. Fields name, description, and authorizationurl are unevaluated and appear in buildtime-evaluatable form.
15 required
BuiltGenericClientKeyResponseAsRsaOaep384
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Extole 12
Other APIs Extole publishes across the network.
Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API
#Security Keys