Schemas

IntegrationCredential

id

string

keyPrefix

string

clientId

string

Presente cuando credentialType es oauth_client

Example: cli_a1b2c3d4e5f6789012345678

apiKeyId

string

Presente cuando credentialType es api_key

Example: ak_live_fd4c66f00071493e8a365582

name

string

description

string | null

credentialType

string · enum

Enum values:

oauth_client

api_key

Example: oauth_client

environment

string · enum

Enum values:

live

test

dev

Example: live

organizationId

string

scopes

string[]

Scopes OAuth (solo informativos; la autorización usa permissions)

Example: ["adamo_sign:write"]

permissions

string[]

Permisos RBAC granulares aplicados en cada solicitud

Example: ["adamo_sign:documents:create","adamo_sign:documents:read"]

allowedAudiences

string[]

accessTokenLifetime

integer

Duración del token en segundos

Example: 3600

RateLimit

Restrictions

expiresAt

string | null · date-time

isActive

boolean

lastUsedAt

string | null · date-time

usageCount

integer

Total de llamadas API realizadas con esta credencial

Example: 1500

tokenIssuanceCount

integer

Veces que se ha emitido un token para esta credencial

Example: 42

rotatedAt

string | null · date-time

Fecha de la última rotación del secreto (solo oauth_client)

Example: 2026-05-01T08:00:00Z

revokedAt

string | null · date-time

createdAt

string · date-time

updatedAt

string · date-time

CreateCredentialRequest

name

string · minLength: 3 · maxLength: 120 · required

credentialType

string · enum · required

Enum values:

oauth_client

api_key

Example: oauth_client

permissions

string[] · minItems: 1 · maxItems: 100 · required

Permisos RBAC granulares a otorgar. Deben ser un subconjunto de los permisos del admin.

Example: ["adamo_sign:documents:create","adamo_sign:documents:read"]

description

string · maxLength: 500

environment

string · enum

Enum values:

live

test

dev

Example: live

Default: live

scopes

string[] · maxItems: 50

Scopes OAuth (opcional; solo informativos)

Example: ["adamo_sign:write"]

allowedAudiences

string[]

accessTokenLifetime

integer · min: 60 · max: 86400

Duración del token en segundos (por defecto 3600)

Example: 3600

RateLimit

Restrictions

expiresAt

string · date-time

UpdateCredentialRequest

name

string · minLength: 3 · maxLength: 120

description

string | null · maxLength: 500

permissions

string[] · minItems: 1 · maxItems: 100

Reemplaza la lista completa de permisos. Mínimo 1 elemento.

Example: ["adamo_sign:documents:create","adamo_sign:documents:read","adamo_sign:documents:void"]

scopes

string[] · maxItems: 50

Scopes OAuth (opcional; solo informativos)

allowedAudiences

string[]

accessTokenLifetime

integer · min: 60 · max: 86400

RateLimit

Restrictions

expiresAt

string | null · date-time

isActive

boolean

OAuthTokenRequest

grant_type

string · enum · required

Enum values:

client_credentials

api_key

Example: client_credentials

client_id

string

Requerido cuando grant_type es client_credentials

Example: cli_a1b2c3d4e5f6789012345678

client_secret

string

Requerido cuando grant_type es client_credentials

Example: cs_abc123...

api_key

string

Requerido cuando grant_type es api_key. Formato: {apiKeyId}:{apiKeySecret}

Example: ak_live_xxx:sk_live_yyy

scope

string

Scope OAuth opcional (reservado para uso futuro, no se aplica)

Example: adamo_sign:write

audience

string

OAuthTokenResponse

access_token

string

JWT Bearer de tipo service

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

token_type

string

expires_in

integer

Segundos hasta la expiración

Example: 3600

scope

string

Scopes OAuth separados por espacio (informativos)

Example: adamo_sign:write

permissions

string[]

Permisos RBAC otorgados (estos sí se aplican en los microservicios)

Example: ["adamo_sign:documents:create","adamo_sign:documents:read"]

GrantablePermissions

products

string[]

Productos accesibles para la organización

Example: ["adamo_sign","adamo_id"]

permissions

string[]

Permisos RBAC granulares que el admin puede delegar a integraciones

Example: ["adamo_sign:documents:create","adamo_sign:documents:read","adamo_sign:templates:read"]

scopesEnforced

boolean

Indica si los scopes OAuth se aplican (actualmente false)

Example: false

hint

string

IntegrationScopes

products

string[]

grantablePermissions

string[]

scopes

string[]

Scopes OAuth disponibles (reservados para uso futuro)

Example: ["adamo_sign:write","adamo_sign:read"]

scopesEnforced

boolean

scopesNote

string

oauthScopesReference

string[]

CredentialUsage

credentialId

string

clientId

string

usageCount

integer

Total de llamadas API realizadas con esta credencial

Example: 1500

tokenIssuanceCount

integer

Veces que se ha emitido un token de servicio

Example: 42

lastUsedAt

string | null · date-time

RateLimit

RotateSecretResponse

credentialType

string

rotatedAt

string · date-time

clientId

string

clientSecret

string

Nuevo secreto del cliente. Solo se muestra una vez — guárdalo de inmediato.

Example: cs_newSecret123...

warning

string

RateLimit

requests

integer · min: 1 · max: 100000 · required

window

string · enum · required

Enum values:

15m

Example: 1h

Restrictions

allowedIPs

string[]

allowedDomains

string[]

Error

success

boolean

error

string

ValidationError

success

boolean

error

string

object[]

IntegrationCredential

id

string

keyPrefix

string

clientId

string

Presente cuando credentialType es oauth_client

Example: cli_a1b2c3d4e5f6789012345678

apiKeyId

string

Presente cuando credentialType es api_key

Example: ak_live_fd4c66f00071493e8a365582

name

string

description

string | null

credentialType

string · enum

Enum values:

oauth_client

api_key

Example: oauth_client

environment

string · enum

Enum values:

live

test

dev

Example: live

organizationId

string

scopes

string[]

Scopes OAuth (solo informativos; la autorización usa permissions)

Example: ["adamo_sign:write"]

permissions

string[]

Permisos RBAC granulares aplicados en cada solicitud

Example: ["adamo_sign:documents:create","adamo_sign:documents:read"]

allowedAudiences

string[]

accessTokenLifetime

integer

Duración del token en segundos

Example: 3600

RateLimit

Restrictions

expiresAt

string | null · date-time

isActive

boolean

lastUsedAt

string | null · date-time

usageCount

integer

Total de llamadas API realizadas con esta credencial

Example: 1500

tokenIssuanceCount

integer

Veces que se ha emitido un token para esta credencial

Example: 42

rotatedAt

string | null · date-time

Fecha de la última rotación del secreto (solo oauth_client)

Example: 2026-05-01T08:00:00Z

revokedAt

string | null · date-time

createdAt

string · date-time

updatedAt

string · date-time

CreateCredentialRequest

name

string · minLength: 3 · maxLength: 120 · required

credentialType

string · enum · required

Enum values:

oauth_client

api_key

Example: oauth_client

permissions

string[] · minItems: 1 · maxItems: 100 · required

Permisos RBAC granulares a otorgar. Deben ser un subconjunto de los permisos del admin.

Example: ["adamo_sign:documents:create","adamo_sign:documents:read"]

description

string · maxLength: 500

environment

string · enum

Enum values:

live

test

dev

Example: live

Default: live

scopes

string[] · maxItems: 50

Scopes OAuth (opcional; solo informativos)

Example: ["adamo_sign:write"]

allowedAudiences

string[]

accessTokenLifetime

integer · min: 60 · max: 86400

Duración del token en segundos (por defecto 3600)

Example: 3600

RateLimit

Restrictions

expiresAt

string · date-time

UpdateCredentialRequest

name

string · minLength: 3 · maxLength: 120

description

string | null · maxLength: 500

permissions

string[] · minItems: 1 · maxItems: 100

Reemplaza la lista completa de permisos. Mínimo 1 elemento.

Example: ["adamo_sign:documents:create","adamo_sign:documents:read","adamo_sign:documents:void"]

scopes

string[] · maxItems: 50

Scopes OAuth (opcional; solo informativos)

allowedAudiences

string[]

accessTokenLifetime

integer · min: 60 · max: 86400

RateLimit

Restrictions

expiresAt

string | null · date-time

isActive

boolean

OAuthTokenRequest

grant_type

string · enum · required

Enum values:

client_credentials

api_key

Example: client_credentials

client_id

string

Requerido cuando grant_type es client_credentials

Example: cli_a1b2c3d4e5f6789012345678

client_secret

string

Requerido cuando grant_type es client_credentials

Example: cs_abc123...

api_key

string

Requerido cuando grant_type es api_key. Formato: {apiKeyId}:{apiKeySecret}

Example: ak_live_xxx:sk_live_yyy

scope

string

Scope OAuth opcional (reservado para uso futuro, no se aplica)

Example: adamo_sign:write

audience

string

OAuthTokenResponse

access_token

string

JWT Bearer de tipo service

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

token_type

string

expires_in

integer

Segundos hasta la expiración

Example: 3600

scope

string

Scopes OAuth separados por espacio (informativos)

Example: adamo_sign:write

permissions

string[]

Permisos RBAC otorgados (estos sí se aplican en los microservicios)

Example: ["adamo_sign:documents:create","adamo_sign:documents:read"]

GrantablePermissions

products

string[]

Productos accesibles para la organización

Example: ["adamo_sign","adamo_id"]

permissions

string[]

Permisos RBAC granulares que el admin puede delegar a integraciones

Example: ["adamo_sign:documents:create","adamo_sign:documents:read","adamo_sign:templates:read"]

scopesEnforced

boolean

Indica si los scopes OAuth se aplican (actualmente false)

Example: false

hint

string