Skip to content
API Reference
/
/
Logout current user

Capsule Security AI Agent Management Platform (1.0.0)

The Capsule Security platform provides comprehensive AI agent security management with advanced monitoring, risk assessment, and compliance capabilities. This API enables integration with multiple AI agent platforms and provides GraphQL endpoints for flexible data querying.

Download OpenAPI description
index.json
index.yaml
Overview
Capsule Security Support

support@capsule.security

License

Proprietary

Languages
Servers
Mock server

https://docs.capsulesecurity.io/_mock/apis/

Production API server

https://api.capsule.security/api/v1/

Staging API server

https://staging.api.capsule.security/api/v1/

Authentication

Operations

Initiate authentication flow

Request

Security
cookieAuth or bearerAuth
Query
redirect_urlstring(uri)required

URL to redirect after successful authentication

curl -i -X GET \
  'https://docs.capsulesecurity.io/_mock/apis/auth/login?redirect_url=http%3A%2F%2Fexample.com' \
  -b session=YOUR_API_KEY_HERE

Responses

Redirect to Auth0 or SSO provider

Headers
Locationstring(uri)

Auth provider URL

Logout current user

Request

Security
cookieAuth or bearerAuth
curl -i -X GET \
  https://docs.capsulesecurity.io/_mock/apis/auth/logout \
  -b session=YOUR_API_KEY_HERE

Responses

Redirect after logout

Headers
Locationstring(uri)

Get current session information

Request

Security
cookieAuth or bearerAuth
curl -i -X GET \
  https://docs.capsulesecurity.io/_mock/apis/auth/session \
  -b session=YOUR_API_KEY_HERE

Responses

Current user session

Bodyapplication/json
userIdstringrequired

Unique user identifier

emailstring(email)required

User email address

namestringrequired

User full name

tenantsobjectrequired

Tenant access and roles mapping

tenants.​property name*objectadditional property
tenantIdsArray of stringsrequired

List of tenant IDs user has access to

organizationobjectrequired

User's organization details

organization.​idstring
organization.​namestring
Response
application/json
{
  "userId": "string",
  "email": "user@example.com",
  "name": "string",
  "tenants": {
    "property1": { … },
    "property2": { … }
  },
  "tenantIds": [
    "string"
  ],
  "organization": {
    "id": "string",
    "name": "string"
  }
}

GraphQL

Operations