stable · api · 0.1.0
Inspect the authenticated Project Client
GET /api/v1/project-client
Capability Domain: Identity Trust
Authentication
projectCredential (clients:read)
Scope: clients:read
Parameters and request body
-
X-Correlation-ID— header, optionalX-Correlation-ID schema { "type": "string", "format": "uuid" }
Responses and errors
| Status | Description |
|---|---|
200 | Authenticated Project Client |
401 | Invalid or revoked Project Credential |
403 | Project Credential lacks the required scope |
429 | Project Client hard quota reached |
200 schema
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"name",
"environment",
"scopes"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"environment": {
"type": "string",
"enum": [
"development",
"sandbox",
"staging",
"production"
]
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}401 schema
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"required": [
"code",
"message",
"retryable",
"correlation_id",
"details"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"correlation_id": {
"type": "string",
"format": "uuid"
},
"details": {
"type": "object"
}
}
}
}
}403 schema
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"required": [
"code",
"message",
"retryable",
"correlation_id",
"details"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"correlation_id": {
"type": "string",
"format": "uuid"
},
"details": {
"type": "object"
}
}
}
}
}429 schema
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"required": [
"code",
"message",
"retryable",
"details",
"correlation_id"
],
"properties": {
"code": {
"type": "string",
"enum": [
"platform_quota_exceeded"
]
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean",
"enum": [
true
]
},
"details": {
"type": "object",
"required": [
"resource",
"used",
"limit",
"retry_after_seconds"
],
"properties": {
"resource": {
"type": "string",
"enum": [
"api_traffic",
"storage_bytes",
"deliveries",
"events",
"scheduled_invocations",
"realtime_connections",
"payment_transactions",
"audit_retention"
]
},
"used": {
"type": "integer",
"minimum": 0
},
"limit": {
"type": "integer",
"minimum": 1
},
"retry_after_seconds": {
"type": "integer",
"minimum": 1
}
}
},
"correlation_id": {
"type": "string",
"format": "uuid"
}
}
}
}
}200 example
{
"data": {
"id": "30000000-0000-4000-8000-000000000003",
"name": "Sandbox Storefront",
"environment": "sandbox",
"scopes": [
"clients:read"
]
}
}429 example
{
"error": {
"code": "platform_quota_exceeded",
"message": "The platform resource hard limit has been reached.",
"retryable": true,
"details": {
"resource": "api_traffic",
"used": 1000,
"limit": 1000,
"retry_after_seconds": 312
},
"correlation_id": "20000000-0000-4000-8000-000000000016"
}
}Idempotency
Safe read; retries do not change Project Client state.