Tolgee Octri Demo
GET/v2/api-keys/current-permissions

Get current credential permissions

Retrieves the permissions granted to the credential used for the request on a project. Supply projectId when using a PAT or an OAuth token that is not bound to exactly one project.

1 parameter
projectIdintegeroptional
The project identifier to retrieve permissions for. Supply it with a PAT or an OAuth token that is not bound to exactly one project.

5 status codes
200Returns the project and project identifier, granted scopes, user scopes, user identifier, and permission settings for the credential.
projectobjectrequired
projectIdintegerrequired
The API key's project id or the one provided as query param
scopesarray<string>required
Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.
stateChangeLanguageIdsarray<integer>optional
List of languages user can change state to. If null, changing state of all language values is permitted.
suggestLanguageIdsarray<integer>optional
List of languages user can suggest to. If null, suggesting to all languages is permitted.
suggestManageLanguageIdsarray<integer>optional
List of languages user can manage suggestions for. If null, managing suggestions for all languages is permitted.
suggestionsModestringrequired
Allowed:DISABLEDENABLED
translateLanguageIdsarray<integer>optional
List of languages user can translate to. If null, all languages editing is permitted.
translationProtectionstringrequired
Allowed:NONEPROTECT_REVIEWED
typestringoptional
The user's permission type. This field is null if user has assigned granular permissions or if returning API key's permissions
Allowed:NONEVIEWTRANSLATEREVIEWEDITMANAGE
userIdintegerrequired
Id of the user the credential belongs to
userScopesarray<string>required
The user's own scopes on the project, not narrowed by the API key or OAuth grant. A scope here but not in `scopes` is one the credential lacks, not the user.
viewLanguageIdsarray<integer>optional
List of languages user can view. If null, all languages view is permitted.
400Returned when the request is invalid, including when a required `projectId` is omitted.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is not authenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user is not permitted to access the project permissions.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the specified project cannot be found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request is invalid, including when projectId is needed but omitted. A 401 is returned when authentication is missing or invalid, a 403 when the authenticated user lacks permission, and a 404 when the project cannot be found. The projectId query parameter must identify the project whose permissions you want to inspect when the credential does not select one project.