Configure Auth API
The Auth API from Configure — 8 operation(s) for auth.
The Auth API from Configure — 8 operation(s) for auth.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/configure-dev:configure-dev-auth-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Configure Dev Auth API
version: 2026-07-12
description: 'Operations tagged Auth across 2 of this provider''s published API definitions: configure-dev-openapi-original.yaml, configure-dev-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.configure.dev
description: Production
- url: https://configure-backend-staging.fly.dev
description: Staging
security:
- ApiKeyAuth: []
tags:
- name: Auth
paths:
/v1/auth/sign-in/agents/{agent}/hosted:
get:
tags:
- Auth
summary: Resolve an agent's hosted sign-in information
description: Returns the canonical sign-in URL and public hosted configuration for an active agent. Callers should send signInUrl unchanged.
security: []
parameters:
- name: agent
in: path
required: true
schema:
$ref: '#/components/schemas/AgentName'
responses:
'200':
description: Public hosted sign-in information.
content:
application/json:
schema:
$ref: '#/components/schemas/HostedAgentSignInInfo'
'404':
description: Agent not found or inactive.
operationId: getV1AuthSignInAgentsByAgentHosted
x-operation-id-source: derived
servers:
- url: https://api.configure.dev
description: Production
- url: https://configure-backend-staging.fly.dev
description: Staging
/v1/auth/sign-in/return-destinations:
get:
tags:
- Auth
summary: List hosted sign-in return destinations
description: Lists allowlisted callbacks and deep links for the acting agent.
security:
- SecretApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AgentHeader'
responses:
'200':
description: Return destinations for the acting agent.
content:
application/json:
schema:
$ref: '#/components/schemas/SignInReturnDestinationList'
operationId: getV1AuthSignInReturnDestinations
x-operation-id-source: derived
post:
tags:
- Auth
summary: Allowlist a hosted sign-in return destination
description: Adds a web callback or native deep link that can receive short-lived hosted sign-in codes.
security:
- SecretApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AgentHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SignInReturnDestinationRequest'
responses:
'201':
description: Return destination allowlisted.
content:
application/json:
schema:
$ref: '#/components/schemas/SignInReturnDestination'
'400':
$ref: '#/components/responses/InvalidFormat'
'403':
$ref: '#/components/responses/Forbidden'
operationId: postV1AuthSignInReturnDestinations
x-operation-id-source: derived
delete:
tags:
- Auth
summary: Remove a hosted sign-in return destination
security:
- SecretApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AgentHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SignInReturnDestinationRequest'
responses:
'200':
description: Return destination removed.
content:
application/json:
schema:
$ref: '#/components/schemas/SignInReturnDestinationDeleteResponse'
'400':
$ref: '#/components/responses/InvalidFormat'
'403':
$ref: '#/components/responses/Forbidden'
operationId: deleteV1AuthSignInReturnDestinations
x-operation-id-source: derived
servers:
- url: https://api.configure.dev
description: Production
- url: https://configure-backend-staging.fly.dev
description: Staging
/v1/auth/sign-in/code:
post:
tags:
- Auth
summary: Create a hosted sign-in return code
description: Configure-hosted pages call this with an approved agent token. The returned code is single-use and expires after five minutes.
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SignInCodeRequest'
responses:
'200':
description: Short-lived sign-in code.
content:
application/json:
schema:
$ref: '#/components/schemas/SignInCodeResponse'
'400':
$ref: '#/components/responses/InvalidFormat'
'403':
$ref: '#/components/responses/Forbidden'
operationId: postV1AuthSignInCode
x-operation-id-source: derived
servers:
- url: https://api.configure.dev
description: Production
- url: https://configure-backend-staging.fly.dev
description: Staging
/v1/auth/sign-in/exchange:
post:
tags:
- Auth
summary: Exchange a hosted sign-in code
description: Exchanges a short-lived cfgsic_ code for an agent-scoped token for the acting agent.
security:
- SecretApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AgentHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SignInExchangeRequest'
responses:
'200':
description: Agent-scoped Configure token.
content:
application/json:
schema:
$ref: '#/components/schemas/SignInExchangeResponse'
'400':
$ref: '#/components/responses/InvalidFormat'
'403':
$ref: '#/components/responses/Forbidden'
operationId: postV1AuthSignInExchange
x-operation-id-source: derived
servers:
- url: https://api.configure.dev
description: Production
- url: https://configure-backend-staging.fly.dev
description: Staging
/v1/auth/sign-in/message-lines:
get:
tags:
- Auth
summary: List message return lines
description: Lists active provider-owned message return lines for the acting agent. Raw phone numbers are never returned.
security:
- SecretApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AgentHeader'
responses:
'200':
description: Active message return lines for the acting agent.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageLineListResponse'
'403':
$ref: '#/components/responses/Forbidden'
operationId: getV1AuthSignInMessageLines
x-operation-id-source: derived
post:
tags:
- Auth
summary: Register a message return line
description: Registers the current provider-owned SMS/iMessage return line for the acting agent before that phone is used in message sign-in URLs. Configure stores only a hash and last4.
security:
- SecretApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AgentHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MessageLineRegistrationRequest'
responses:
'201':
description: Message return line registered.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageLineRegisterResponse'
'400':
$ref: '#/components/responses/InvalidFormat'
'403':
$ref: '#/components/responses/Forbidden'
operationId: postV1AuthSignInMessageLines
x-operation-id-source: derived
delete:
tags:
- Auth
summary: Revoke a message return line
description: Revokes a provider-owned message return line for the acting agent. Future message URL requests using that phone are rejected until the line is registered again.
security:
- SecretApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AgentHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MessageLineRegistrationRequest'
responses:
'200':
description: Message return line revocation result.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageLineRevokeResponse'
'400':
$ref: '#/components/responses/InvalidFormat'
'403':
$ref: '#/components/responses/Forbidden'
operationId: deleteV1AuthSignInMessageLines
x-operation-id-source: derived
servers:
- url: https://api.configure.dev
description: Production
- url: https://configure-backend-staging.fly.dev
description: Staging
/v1/auth/sign-in/message-url:
post:
tags:
- Auth
summary: Create a message sign-in URL
description: Creates a hosted sign-in, reconnect, or permission-review URL for a message-channel sender. If a messageLinePhone or agentPhone is supplied, it must be an active registered message line for the acting agent and channel. Code-bearing responses require verified provider-signed message sender proof; without it, the endpoint returns the plain sign-in.me handoff and creates no code.
security:
- SecretApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AgentHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SignInMessageUrlRequest'
responses:
'200':
description: Hosted message sign-in URL.
content:
application/json:
schema:
$ref: '#/components/schemas/SignInMessageUrlResponse'
'400':
$ref: '#/components/responses/InvalidFormat'
'403':
$ref: '#/components/responses/Forbidden'
operationId: postV1AuthSignInMessageUrl
x-operation-id-source: derived
servers:
- url: https://api.configure.dev
description: Production
- url: https://configure-backend-staging.fly.dev
description: Staging
/v1/auth/sign-in/recognize-phone:
post:
tags:
- Auth
summary: Recognize a message sender by phone candidates
description: Trusted message-agent endpoint for recognizing phone-like sender IDs. A token is returned only when the user has approved the acting agent.
security:
- SecretApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AgentHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SignInPhoneRecognitionRequest'
responses:
'200':
description: Phone recognition result.
content:
application/json:
schema:
$ref: '#/components/schemas/SignInPhoneRecognitionResponse'
'400':
$ref: '#/components/responses/InvalidFormat'
'403':
$ref: '#/components/responses/Forbidden'
operationId: postV1AuthSignInRecognizePhone
x-operation-id-source: derived
servers:
- url: https://api.configure.dev
description: Production
- url: https://configure-backend-staging.fly.dev
description: Staging
/v1/auth/sign-in/validate:
post:
tags:
- Auth
summary: Validate a Configure OAuth agent token
description: Server-side validation for agent-scoped tokens returned by Configure OAuth. Use this to restore host-app sessions; /v1/me accepts user-scoped JWTs and is not the SSO session validator.
security:
- SecretApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/AgentHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SignInValidateRequest'
responses:
'200':
description: Validation result.
content:
application/json:
schema:
$ref: '#/components/schemas/SignInValidateResponse'
'400':
$ref: '#/components/responses/InvalidFormat'
'403':
$ref: '#/components/responses/Forbidden'
operationId: postV1AuthSignInValidate
x-operation-id-source: derived
servers:
- url: https://api.configure.dev
description: Production
- url: https://configure-backend-staging.fly.dev
description: Staging
components:
schemas:
MessageLineRegistrationRequest:
type: object
required:
- phone
properties:
channel:
type: string
default: imessage
minLength: 1
maxLength: 40
pattern: ^[a-z0-9][a-z0-9_-]{0,39}$
example: sms
phone:
type: string
minLength: 1
maxLength: 80
description: Current provider-owned message return line in E.164 format.
example: '+14155550123'
label:
type: string
maxLength: 120
nullable: true
example: Primary SMS line
metadata:
type: object
additionalProperties: true
description: Small server-side metadata object for provider bookkeeping.
SignInCodeRequest:
type: object
required:
- return_to
properties:
return_to:
type: string
minLength: 1
maxLength: 2048
state:
type: string
maxLength: 1024
AgentName:
type: string
minLength: 2
maxLength: 63
pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
example: your-agent
SignInReturnDestination:
type: object
required:
- destination
properties:
destination:
type: string
example: https://app.example.com/auth/configure/callback
created_at:
type: string
format: date-time
HostedAgentSignInInfo:
type: object
required:
- agent
- signInUrl
- displayName
properties:
agent:
$ref: '#/components/schemas/AgentName'
signInUrl:
type: string
format: uri
example: https://sign-in.me/your-agent
displayName:
type: string
example: Your Agent
logoUrl:
type:
- string
- 'null'
format: uri
hostedMetadataUrl:
type:
- string
- 'null'
format: uri
publishableKey:
type:
- string
- 'null'
pattern: ^pk_
ErrorEnvelope:
type: object
properties:
error:
type: object
properties:
type:
type: string
code:
type: string
message:
type: string
param:
type:
- string
- 'null'
retryable:
type: boolean
request_id:
type: string
SignInValidateRequest:
type: object
required:
- token
properties:
token:
type: string
minLength: 1
description: Agent-scoped JWT returned by hosted sign-in exchange, message completion, or phone recognition.
SignInMessageUrlSubject:
type: object
required:
- key
- externalId
properties:
key:
type: string
minLength: 1
maxLength: 256
description: Stable adapter subject key for the message sender.
externalId:
type: string
minLength: 1
maxLength: 512
description: Developer-scoped external ID used before the sender links Configure.
senderId:
type: string
maxLength: 512
SignInPhoneRecognitionRequest:
type: object
properties:
candidates:
type: array
maxItems: 80
items:
type: string
description: Phone-like sender IDs such as E.164, tel:, sms:, imessage:, or formatted phone strings.
MessageLineRegisterResponse:
type: object
required:
- line
properties:
line:
$ref: '#/components/schemas/MessageLine'
MessageLine:
type: object
required:
- id
- channel
- phoneLast4
- label
- status
properties:
id:
type: string
format: uuid
channel:
type: string
example: sms
phoneLast4:
type: string
minLength: 4
maxLength: 4
description: Last four digits of the registered line. Raw phone numbers are never returned.
example: '0123'
label:
type: string
nullable: true
example: Primary SMS line
status:
type: string
enum:
- active
- revoked
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
MessageLineListResponse:
type: object
required:
- lines
properties:
lines:
type: array
items:
$ref: '#/components/schemas/MessageLine'
SignInMessageUrlPlainResponse:
type: object
required:
- mode
- url
- reason
- fallbackReason
properties:
mode:
type: string
const: plain
url:
type: string
example: https://sign-in.me/your-agent
reason:
type: string
enum:
- signin
- reconnect
- permissions
fallbackReason:
type: string
enum:
- sender_proof_missing
- sender_proof_invalid
- sender_proof_unsupported
idempotencyKey:
type: string
SignInExchangeResponse:
type: object
required:
- token
- userId
- tokenUse
- approved
- agent
properties:
token:
type: string
description: Agent-scoped Configure token for the acting agent.
userId:
type: string
tokenUse:
type: string
enum:
- agent
approved:
type: boolean
agent:
$ref: '#/components/schemas/AgentName'
SignInValidateResponse:
type: object
required:
- valid
properties:
valid:
type: boolean
userId:
type: string
description: Present when valid is true.
tokenUse:
type: string
enum:
- agent
approved:
type: boolean
agent:
$ref: '#/components/schemas/AgentName'
SignInMessageUrlThread:
type: object
properties:
key:
type: string
maxLength: 512
spaceId:
type: string
maxLength: 512
messageId:
type: string
maxLength: 512
SignInMessageUrlMintedResponse:
type: object
required:
- mode
- url
- code
- reason
- expiresAt
properties:
mode:
type: string
const: minted
url:
type: string
example: https://sign-in.me/your-agent/cfgmsg_example
code:
type: string
pattern: ^cfgmsg_
reason:
type: string
enum:
- signin
- reconnect
- permissions
expiresAt:
type: string
format: date-time
idempotencyKey:
type: string
SignInExchangeRequest:
type: object
required:
- code
properties:
code:
type: string
pattern: ^cfgsic_
SignInPhoneRecognitionResponse:
type: object
required:
- matched
- approved
- phoneCandidateCount
properties:
matched:
type: boolean
recognized:
type: boolean
approved:
type: boolean
linked:
type: boolean
token:
type: string
description: Present only when approved and linked are true.
agentToken:
type: string
description: Alias for token.
userId:
type: string
agent:
$ref: '#/components/schemas/AgentName'
displayName:
type: string
nullable: true
phoneCandidateCount:
type: integer
SignInReturnDestinationDeleteResponse:
allOf:
- $ref: '#/components/schemas/SignInReturnDestination'
- type: object
properties:
deleted:
type: boolean
const: true
SignInReturnDestinationList:
type: object
required:
- destinations
properties:
destinations:
type: array
items:
$ref: '#/components/schemas/SignInReturnDestination'
SignInMessageUrlResponse:
oneOf:
- $ref: '#/components/schemas/SignInMessageUrlMintedResponse'
- $ref: '#/components/schemas/SignInMessageUrlPlainResponse'
SignInCodeResponse:
type: object
required:
- code
- returnTo
- expiresIn
- tokenUse
properties:
code:
type: string
pattern: ^cfgsic_
state:
type: string
nullable: true
returnTo:
type: string
expiresIn:
type: integer
example: 300
tokenUse:
type: string
enum:
- sign_in_code
SignInReturnDestinationRequest:
type: object
required:
- return_to
properties:
return_to:
type: string
minLength: 1
maxLength: 2048
description: Absolute web callback URL or native deep link. URL fragments are stripped before storage.
example: https://app.example.com/auth/configure/callback
MessageLineRevokeResponse:
type: object
required:
- deleted
- lines
properties:
deleted:
type: boolean
lines:
type: array
items:
$ref: '#/components/schemas/MessageLine'
SignInMessageUrlRequest:
type: object
required:
- channel
- subject
properties:
reason:
type: string
enum:
- signin
- reconnect
- permissions
default: signin
channel:
type: string
minLength: 1
maxLength: 80
example: sms
subject:
$ref: '#/components/schemas/SignInMessageUrlSubject'
thread:
$ref: '#/components/schemas/SignInMessageUrlThread'
messageSenderProof:
type: string
maxLength: 8192
description: Provider-signed evidence that the message sender/thread claim is authentic. A code-bearing URL is returned only when Configure can verify this value.
connectors:
type: array
maxItems: 20
items:
type: string
displayName:
type: string
maxLength: 120
agentLogo:
type: string
maxLength: 2048
theme:
type: string
enum:
- light
- dark
messageLinePhone:
type: string
maxLength: 80
description: Current provider-owned message line that users return to after hosted sign-in. Must already be registered for the acting agent and channel.
example: '+14155550123'
agentPhone:
type: string
maxLength: 80
description: Alias for messageLinePhone. Prefer this when resolving the agent's current line from the messaging provider.
example: '+14155550123'
messageBody:
type: string
maxLength: 280
description: Suggested SMS/iMessage body for returning to the agent.
messageCompleteUrl:
type: string
maxLength: 2048
description: Optional trusted completion endpoint called by hosted sign-in after approval.
journeyId:
type: string
maxLength: 256
description: Optional application journey identifier used to map hosted completion back to a message thread.
returnMode:
type: string
enum:
- message
default: message
idempotencyKey:
type: string
maxLength: 256
parameters:
AgentHeader:
name: X-Agent
in: header
required: false
schema:
$ref: '#/components/schemas/AgentName'
description: Required when the API key's developer account owns more than one active agent.
responses:
InvalidFormat:
description: Request shape is invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
Forbidden:
description: Forbidden. Common causes include secret_key_required, token_wrong_type, approval_required, or access_denied.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: Configure API key. Use sk_ on servers. pk_ is browser-safe but restricted.
SecretApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: Server-side Configure secret key, prefix sk_.
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: Agent-scoped Configure token from hosted Configure.link().
ExternalUserId:
type: apiKey
in: header
name: X-User-Id
description: Stable external user ID for unlinked developer-scoped profiles. Requires sk_.
x-refined-from:
- configure-dev-openapi-original.yaml
- configure-dev-openapi.yml