How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, 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.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

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
verifyJwtClientKey 1 param body → 200400401402403415429
GET
/v2/settings/security/keys
List client keys
listClientKeys 1 param → 200400401402403415429
POST
/v2/settings/security/keys
Create client key
createClientKey body → 200400401402403415429
GET
/v2/settings/security/keys/built
List built client keys
listBuiltClientKeys 1 param → 200400401402403415429
POST
/v2/settings/security/keys/{key_id}/delete
Delete client key
deleteClientKey 1 param → 200400401402403415429
POST
/v2/settings/security/keys/{key_id}/unarchive
Unarchive client key
unarchiveClientKey 1 param → 200400401402403415429
PUT
/v2/settings/security/keys/{key_id}
Update client key
updateClientKey 1 param body → 200400401402403415429
DELETE
/v2/settings/security/keys/{key_id}
Archive client key
archiveClientKey 1 param → 200400401402403415429

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.

AuthorizationUrlInOAuthClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
DescriptionInClientKeyResponseBase
Optional build-time expression that resolves to a human-readable description.
GenericClientKeyResponseAsEs256Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyResponseAsRs256Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
DescriptionInOAuthSfdcPasswordClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsEs512Public
object
1 required
GenericClientKeyResponseAsRs384Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
OAuthSalesforceClientKeyResponse
object
Stored oauth salesforce client key definition. Fields name, description, and authorizationurl are unevaluated and appear in buildtime-evaluatable form.
16 required
GenericClientKeyResponseAsRsaOaep256Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyUpdateRequestAsRsaOaep256Private
object
1 required
AuthorizationUrlInOAuthSalesforceClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
GenericClientKeyCreateRequestAsEs256Private
object
6 required
AuthorizationUrlInOAuthSalesforceClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
DescriptionInGenericClientKeyUpdateRequestAsRs384Private
New build-time expression for the description. Omit to leave unchanged.
BuiltGenericClientKeyResponseAsEs384
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyResponseAsPs512Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyResponseAsHs384
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
BuiltGenericClientKeyResponseAsPs384
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyCreateRequestAsPs256Public
object
6 required
GenericClientKeyUpdateRequestAsPs256Public
object
1 required
GenericClientKeyResponseAsPs384Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyCreateRequestAsPs256Private
object
6 required
OAuthSfdcClientKeyResponse
object
Stored oauth sfdc client key definition. Fields name, description, and authorizationurl are unevaluated and appear in buildtime-evaluatable form.
15 required
GenericClientKeyResponseAsPs256Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
DescriptionInGenericClientKeyUpdateRequestAsEs256Public
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
GenericClientKeyResponseAsA128kw
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
BuiltOAuthOptimoveClientKeyResponse
object
15 required
GenericClientKeyUpdateRequestAsHs384
object
1 required
GenericClientKeyResponseAsEs384Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
BuiltGenericClientKeyResponseAsRsaOaep384
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyUpdateRequestAsRs512Private
object
1 required
BuiltGenericClientKeyResponseAsRsaOaep256
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
OAuthSfdcPasswordClientKeyCreateRequest
object
11 required
OAuthOptimoveClientKeyCreateRequest
object
9 required
BuiltGenericClientKeyResponseAsRs256
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
DescriptionInGenericClientKeyUpdateRequestAsPs384Public
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyResponseAsRsa
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyUpdateRequestAsPs512Public
object
1 required
DescriptionInSslPkcs12ClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
OAuthSfdcClientKeyUpdateRequest
object
1 required
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
DescriptionInOAuthOptimoveClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyCreateRequestAsRsaOaep512Private
object
6 required
SslPkcs12ClientKeyUpdateRequest
object
1 required
BuiltGenericClientKeyResponseAsRsaOaep512
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyResponseAsA256kw
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyCreateRequestAsEs384Private
object
6 required
GenericClientKeyCreateRequestAsRsa
object
6 required
BuiltClientKeyResponse
client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
BuiltGenericClientKeyResponseAsHs512
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
OAuthGenericClientKeyCreateRequest
object
9 required
GenericClientKeyCreateRequestAsEs384Public
object
6 required
AuthorizationUrlInOAuthListrakClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
NameInStringBasedClientKeyCreateRequestBase
Build-time expression that resolves to the display name for the key.
GenericClientKeyUpdateRequestAsRsaOaep256Public
object
1 required
SslPkcs12ClientKeyResponse
object
Stored ssl pkcs12client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
13 required
GenericClientKeyUpdateRequestAsRsaOaep512Public
object
1 required
BuiltOAuthSfdcPasswordClientKeyResponse
object
17 required
GenericClientKeyCreateRequestAsRsaOaep256Private
object
6 required
GenericClientKeyUpdateRequestAsRs512Public
object
1 required
OAuthLeadPerfectionClientKeyCreateRequest
object
9 required
OAuthOptimoveClientKeyResponse
object
Stored oauth optimove client key definition. Fields name, description, and authorizationurl are unevaluated and appear in buildtime-evaluatable form.
15 required
GenericClientKeyUpdateRequestAsRs256Public
object
1 required
NameInClientKeyResponseBase
Display name for the key, in the same build-time evaluatable form that was supplied on create or update.
DescriptionInGenericClientKeyUpdateRequestAsPs512Private
New build-time expression for the description. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsRsaOaep512Public
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsHs256
object
1 required
GenericClientKeyResponseAsA192kw
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyUpdateRequestAsRsaOaep512Private
object
1 required
GenericClientKeyCreateRequestAsHs384
object
6 required
DescriptionInGenericClientKeyUpdateRequestAsRsa
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsRs384Public
object
1 required
GenericClientKeyCreateRequestAsPassword
object
6 required
GenericClientKeyCreateRequestAsHs512
object
6 required
GenericClientKeyCreateRequestAsA128kw
object
6 required
BuiltOAuthSalesforceClientKeyResponse
object
16 required
GenericClientKeyCreateRequestAsRsaOaep512Public
object
6 required
GenericClientKeyUpdateRequestAsRs256Private
object
1 required
DescriptionInGenericClientKeyUpdateRequestAsEs384Public
New build-time expression for the description. Omit to leave unchanged.
OAuthGenericClientKeyUpdateRequest
object
1 required
BuiltClientKeyResponseBase
object
12 properties
GenericClientKeyCreateRequestAsPs384Private
object
6 required
GenericClientKeyResponseAsRs512Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
ResponseHandlerInOAuthGenericClientKeyUpdateRequest
Choose between static or dynamic response handler
ComponentReferenceResponse
object
2 properties
GenericClientKeyCreateRequestAsRs256Private
object
6 required
DescriptionInGenericClientKeyUpdateRequestAsHs512
New build-time expression for the description. Omit to leave unchanged.
OAuthListrakClientKeyResponse
object
Stored oauth listrak client key definition. Fields name, description, and authorizationurl are unevaluated and appear in buildtime-evaluatable form.
15 required
GenericClientKeyResponseAsPs256Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
BuiltOAuthListrakClientKeyResponse
object
15 required
AuthorizationUrlInOAuthLeadPerfectionClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
ComponentReferenceRequest
object
2 properties
DescriptionInGenericClientKeyUpdateRequestAsPs512Public
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsEs256Public
object
1 required
BuiltGenericClientKeyResponseAsPs256
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyCreateRequestAsRs512Private
object
6 required
ResponseHandlerInOAuthGenericClientKeyResponse
The response handler as configured: a literal value, or an expression (type:string) when defined dynamically.
GenericClientKeyCreateRequestAsHs256
object
6 required
OAuthSalesforceClientKeyUpdateRequest
object
1 required
GenericClientKeyUpdateRequestAsPs256Private
object
1 required
GenericClientKeyResponseAsRsaOaep256Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
AuthorizationUrlInOAuthGenericClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
OAuthOptimoveClientKeyUpdateRequest
object
1 required
GenericClientKeyResponseAsRsaOaep384Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
AuthorizationUrlInOAuthGenericClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
ClientKeyResponseBase
object
12 properties
RequestInOAuthGenericClientKeyResponse
The request as configured: a literal value, or an expression (type:string) when defined dynamically.
OAuthSfdcPasswordClientKeyUpdateRequest
object
1 required
DescriptionInGenericClientKeyUpdateRequestAsRs256Public
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.
BuiltOAuthClientKeyResponse
object
15 required
GenericClientKeyUpdateRequestAsEs384Public
object
1 required
GenericClientKeyUpdateRequestAsA128kw
object
1 required
AuthorizationUrlInOAuthListrakClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
OAuthClientKeyResponse
object
Stored oauth client key definition. Fields name, description, and authorizationurl are unevaluated and appear in buildtime-evaluatable form.
15 required
GenericClientKeyCreateRequestAsRs256Public
object
6 required
GenericClientKeyCreateRequestAsRs512Public
object
6 required
DescriptionInOAuthGenericClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyResponseAsPassword
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
DescriptionInGenericClientKeyUpdateRequestAsRs384Public
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyResponseAsEs512Private
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
OAuthListrakClientKeyCreateRequest
object
9 required
NameInClientKeyUpdateRequestBase
New build-time expression for the display name. Omit to leave unchanged.
GenericClientKeyResponseAsPs512Public
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
GenericClientKeyResponseAsRsaOaep384Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
AuthorizationUrlInOAuthSfdcClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsPs256Public
New build-time expression for the description. Omit to leave unchanged.
BuiltGenericClientKeyResponseAsRs384
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyUpdateRequestAsHttpBasic
object
1 required
JwtClientKeyVerifyJwtRequest
object
1 property 1 required
GenericClientKeyResponseAsHs512
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
BuiltSslPkcs12ClientKeyResponse
object
ssl pkcs12client key after buildtime evaluation. Fields name and description are already evaluated.
13 required
GenericClientKeyResponseAsRsaOaep512Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
RequestInOAuthGenericClientKeyUpdateRequest
Choose between static or dynamic request
AuthorizationUrlInOAuthSfdcPasswordClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
DescriptionInGenericClientKeyUpdateRequestAsEs256Private
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyCreateRequestAsRs384Public
object
6 required
GenericClientKeyCreateRequestAsRsaOaep384Private
object
6 required
ResponseHandlerInOAuthGenericClientKeyCreateRequest
Choose between static or dynamic response handler
DescriptionInGenericClientKeyUpdateRequestAsEs512Private
New build-time expression for the description. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsRsaOaep384Private
New build-time expression for the description. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsA192kw
New build-time expression for the description. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsA128kw
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyCreateRequestAsEs512Private
object
6 required
BuiltGenericClientKeyResponseAsHs256
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyUpdateRequestAsRsaOaep384Public
object
1 required
BuiltGenericClientKeyResponseAsHttpBasic
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
AuthorizationUrlInOAuthSfdcPasswordClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
GenericClientKeyCreateRequestAsEs256Public
object
6 required
AuthorizationUrlInOAuthListrakClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
GenericClientKeyUpdateRequestAsEs512Private
object
1 required
AuthorizationUrlInOAuthGenericClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
AuthorizationUrlInOAuthOptimoveClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsRsaOaep512Private
New build-time expression for the description. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsRsaOaep256Public
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyResponseAsHttpBasic
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
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…
BuiltOAuthLeadPerfectionClientKeyResponse
object
17 required
GenericClientKeyUpdateRequestAsRsa
object
1 required
OAuthClientKeyCreateRequest
object
9 required
BuiltOAuthSfdcClientKeyResponse
object
15 required
AuthorizationUrlInOAuthClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
DescriptionInOAuthSalesforceClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
DescriptionInClientKeyUpdateRequestBase
New build-time expression for the description. Omit to leave unchanged.
BuiltGenericClientKeyResponseAsHs384
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
ResponseHandlerInBuiltOAuthGenericClientKeyResponse
The response handler as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltGenericClientKeyResponseAsPs512
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
DescriptionInGenericClientKeyUpdateRequestAsRsaOaep384Public
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsEs256Private
object
1 required
GenericClientKeyCreateRequestAsPs384Public
object
6 required
BuiltGenericClientKeyResponseAsEs512
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyResponseAsEs256Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
ClientKeyUpdateRequestBase
object
6 properties
DescriptionInOAuthListrakClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsPassword
object
1 required
OAuthGenericClientKeyResponse
object
Stored oauth generic client key definition. Fields name, description, authorizationurl, request, and responsehandler are unevaluated and appear in buildtime-ev…
17 required
GenericClientKeyResponseAsEs384Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyCreateRequestAsHttpBasic
object
6 required
StringBasedClientKeyCreateRequest
Body of a POST /v2/settings/security/keys request.
6 required
RequestInOAuthGenericClientKeyCreateRequest
Choose between static or dynamic request
RequestInBuiltOAuthGenericClientKeyResponse
The request as configured: a literal value, or an expression (type:string) when defined dynamically.
BuiltGenericClientKeyResponseAsRsa
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
DescriptionInStringBasedClientKeyCreateRequestBase
Optional build-time expression that resolves to a human-readable description.
GenericClientKeyCreateRequestAsEs512Public
object
6 required
DescriptionInGenericClientKeyUpdateRequestAsPassword
New build-time expression for the description. Omit to leave unchanged.
BuiltGenericClientKeyResponseAsA128kw
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyResponseAsHs256
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
OAuthLeadPerfectionClientKeyUpdateRequest
object
1 required
AuthorizationUrlInOAuthClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
BuiltGenericClientKeyResponseAsRs512
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
OAuthSfdcClientKeyCreateRequest
object
9 required
DescriptionInGenericClientKeyUpdateRequestAsPs256Private
New build-time expression for the description. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsEs384Private
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsRsaOaep384Private
object
1 required
DescriptionInGenericClientKeyUpdateRequestAsEs512Public
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyUpdateRequestAsA256kw
object
1 required
DescriptionInGenericClientKeyUpdateRequestAsA256kw
New build-time expression for the description. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsHs384
New build-time expression for the description. Omit to leave unchanged.
AuthorizationUrlInOAuthSfdcClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
GenericClientKeyResponseAsRs384Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyResponseAsRsaOaep512Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 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
DescriptionInGenericClientKeyUpdateRequestAsHs256
New build-time expression for the description. Omit to leave unchanged.
DescriptionInGenericClientKeyUpdateRequestAsRs512Public
New build-time expression for the description. Omit to leave unchanged.
JwtClientKeyVerifyJwtResponse
object
2 properties 2 required
DescriptionInOAuthClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
BuiltGenericClientKeyResponseAsEs256
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
DescriptionInGenericClientKeyUpdateRequestAsPs384Private
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyResponseAsRs256Public
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyUpdateRequestAsPs384Private
object
1 required
ClientKeyUpdateRequest
Body of a PUT /v2/settings/security/keys/{keyid} request.
1 required
GenericClientKeyUpdateRequestAsA192kw
object
1 required
BuiltGenericClientKeyResponseAsA256kw
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
DescriptionInGenericClientKeyUpdateRequestAsRs512Private
New build-time expression for the description. Omit to leave unchanged.
DescriptionInOAuthSfdcClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
AuthorizationUrlInOAuthOptimoveClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
OAuthClientKeyUpdateRequest
object
1 required
DescriptionInOAuthLeadPerfectionClientKeyUpdateRequest
New build-time expression for the description. Omit to leave unchanged.
GenericClientKeyCreateRequestAsA256kw
object
6 required
DescriptionInGenericClientKeyUpdateRequestAsRsaOaep256Private
New build-time expression for the description. Omit to leave unchanged.
OAuthSalesforceClientKeyCreateRequest
object
10 required
AuthorizationUrlInOAuthSalesforceClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
GenericClientKeyCreateRequestAsA192kw
object
6 required
StringBasedClientKeyCreateRequestBase
object
9 properties
GenericClientKeyUpdateRequestAsPs512Private
object
1 required
OAuthListrakClientKeyUpdateRequest
object
1 required
GenericClientKeyResponseAsPs384Private
object
Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.
12 required
GenericClientKeyUpdateRequestAsPs384Public
object
1 required
BuiltGenericClientKeyResponseAsA192kw
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyCreateRequestAsRsaOaep256Public
object
6 required
GenericClientKeyCreateRequestAsPs512Private
object
6 required
GenericClientKeyUpdateRequestAsHs512
object
1 required
AuthorizationUrlInOAuthOptimoveClientKeyCreateRequest
Build-time expression that resolves to the OAuth 2.0 authorization endpoint URL.
BuiltGenericClientKeyResponseAsPassword
object
generic client key after buildtime evaluation. Fields name and description are already evaluated.
12 required
GenericClientKeyCreateRequestAsRsaOaep384Public
object
6 required
AuthorizationUrlInOAuthLeadPerfectionClientKeyResponse
OAuth 2.0 authorization endpoint URL, in build-time evaluatable form.
ClientKeyResponse
12 required
GenericClientKeyUpdateRequestAsRs384Private
object
1 required
DescriptionInGenericClientKeyUpdateRequestAsHttpBasic
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.
DescriptionInGenericClientKeyUpdateRequestAsRs256Private
New build-time expression for the description. Omit to leave unchanged.
BuiltOAuthGenericClientKeyResponse
object
17 required
AuthorizationUrlInOAuthLeadPerfectionClientKeyUpdateRequest
New build-time expression for the authorization endpoint URL. Omit to leave unchanged.
GenericClientKeyCreateRequestAsPs512Public
object
6 required
GenericClientKeyCreateRequestAsRs384Private
object
6 required
GenericClientKeyUpdateRequestAsEs384Private
object
1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-security-keys-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Extole Security Keys API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.