Для AI-агентов: markdown этой страницы — /docs/api-op-getentitlements.md · индекс документации — /llms.txt
getEntitlements
Обновлено
GET /api/v1/entitlements
getEntitlements
#Авторизация и права
Scopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.
| Поле | Значение |
|---|
| security.0.hubApiKey | [] |
| security.1.hubBearer | [] |
| securitySchemes.hubApiKey.in | "header" |
| securitySchemes.hubApiKey.name | "X-Api-Key" |
| securitySchemes.hubApiKey.type | "apiKey" |
| securitySchemes.hubBearer.scheme | "bearer" |
| securitySchemes.hubBearer.type | "http" |
| x-required-scopes | ["entitlements"] |
#Параметры запроса
| Поле | Значение |
|---|
| 0.in | "query" |
| 0.name | "user_id" |
| 0.required | true |
| 0.schema | 0.schema |
#Тело запроса
| Поле | Значение |
|---|
| Тело запроса | null |
#Ответы
#Ошибки
| Поле | Значение |
|---|
| 400.content.application/problem+json.schema | ProblemDetails |
| 400.description | "INVALID_REQUEST: user_id query parameter is required" |
| 401.content.application/problem+json.schema | ProblemDetails |
| 401.description | "Missing, invalid, expired or revoked authentication" |
| 403.content.application/problem+json.schema | ProblemDetails |
| 403.description | "Required scope, plan or resource policy refused the caller" |
| 404.content.application/problem+json.schema | ProblemDetails |
| 404.description | "RESOURCE_NOT_FOUND: external app mapping is absent/unconfirmed or resolved user does not belong to this tenant" |
| 413.content.application/problem+json.schema | ProblemDetails |
| 413.description | "PAYLOAD_TOO_LARGE or ITEM_COUNT_EXCEEDED: resource policy cap exceeded" |
| 429.content.application/problem+json.schema | ProblemDetails |
| 429.description | "RATE_LIMIT_EXCEEDED or RATE_LIMIT_UNAVAILABLE: resource limiter refuses or fails closed" |
| 429.headers.Retry-After.description | "Seconds supplied by resource guard when available" |
| 429.headers.Retry-After.schema | 429.headers.Retry-After.schema |
| 500.content.application/problem+json.schema | ProblemDetails |
| 500.description | "INTERNAL_ERROR: unexpected storage or service failure" |
#Дополнительные условия
| Поле | Значение |
|---|
| operationId | "getEntitlements" |
| tags | ["entitlements"] |
| x-idempotency | "none" |