Tolgee Octri Demo
GET/v2/public/scope-info/hierarchy

Get the scope hierarchy

Lists the hierarchy of scopes and the scopes each one requires. Use the optional search parameter to filter the hierarchy by a search string. Each result includes a scope and its required scopes.

1 parameter
searchstringoptional
Text used to filter the scope hierarchy.

5 status codes
200Returns scope hierarchy items, each containing a scope and an array of scopes it requires.
requiresarray<unknown>required
scopestringrequired
Allowed:translations.viewtranslations.edittranslations.suggesttranslation-suggestions.managetranslation-suggestions.own-accesskeys.editscreenshots.uploadscreenshots.deletescreenshots.viewactivity.viewlanguages.editadmin
400Returned when the request is invalid.
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 unauthenticated.
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 access is forbidden.
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 requested resource is not 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 indicates an invalid request, a 401 indicates the request is unauthenticated, a 403 indicates the authenticated user lacks permission, and a 404 indicates the requested resource was not found. Use search as a text filter when you want to narrow the returned scope hierarchy.