> ## Documentation Index > Fetch the complete documentation index at: https://mintlify.hoop.dev/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get Organization Onboarding Status > Get the setup checklist state for the caller's organization. Each step latches the first time it is satisfied, so a check never reverts. Once every check passes, `show_setup_checklist` on /userinfo turns false — the signal to stop calling this endpoint. ## OpenAPI ````yaml https://use.hoop.dev/api/openapiv3.json get /orgs/onboarding openapi: 3.0.3 info: contact: email: help@hoop.dev name: Help url: https://help.hoop.dev description: >- Hoop.dev is an access gateway for databases and servers with an API for packet manipulation license: name: MIT url: https://opensource.org/license/mit termsOfService: https://hoop.dev/docs/legal/tos title: Hoop Api version: 1.144.0 servers: - url: https://use.hoop.dev/api security: [] tags: - description: > Hoop implements Oauth2 and OIDC protocol to authenticate users in the system. To obtain a valid access token users need to authenticate in their own identity provider which is generated as a JSON response to the endpoint `http(s)://use.hoop.dev/api/login`. The identity provider them redirects the user to the callback endpoint containing the access token. The recommended approach of obtaining an access token is by visiting the Webapp main's page or using the **Hoop command line**. Example: ```sh hoop config create --api-url https://use.hoop.dev # save the token after authenticating at $HOME/.hoop/config.toml hoop login # show token information hoop config view --raw ``` With an access token you could use any HTTP client to interact with the documented endpoints. The token must be sent through the `Authorization` header. Example: ```sh # obtain the current configuration of the server curl https://use.hoop.dev/api/serverinfo -H "Authorization: Bearer $ACCESS_TOKEN" ``` name: Authentication - description: > Users are active and assigned to the default organization when they signup. A user could be set to an inactive state preventing it from accessing the platform, however it’s recommended to manage the state of users in the identity provider. - The `sub` claim is used as the main identifier of the user in the platform. - The profile of the user is derived from the id_token claims `email` and `name`. When a user authenticates for the first time, it performs an automatic signup that persist the profile claims along with it’s unique identifier. ​ ### Groups Groups allows defining who may access or interact with certain resources. - For connection resources it’s possible to define which groups has access to a specific connection, this is enforced when the Access Control feature is enabled. - For review resources, it’s possible to define which groups are allowed to approve an execution, this is enforced when the Review feature is enabled. > This resource could be managed manually via Webapp or propagated by the identity provider via ID Token. In this mode, groups are sync when a user performs a login. ### Roles - The `admin` group is a special role that grants full access to all resources This role should be granted to users that are responsible for managing the Gateway. All other users are regular, meaning that they can access their own resources and interact with connections. name: User Management - name: Machine Identities - description: Routes used to manage and obtain information about the runtime server. name: Server Management - description: Features available in the gateway. See also **Plugin** resources. name: Features - description: >- Proxy manager endpoints controls how clients connect via gRPC in the gateway. These endpoints are meant to be used when a client is initialized via `hoop proxy-manager`. name: Proxy Manager - name: Connections - name: Agents - name: Runbooks - name: Guard Rails - name: Reviews - name: Sessions - name: Organization Management - name: Reports - description: > Security audit log API. Only users in the **admin** group can access these endpoints. Audit log entries record security-relevant events (who performed an action, when, on which resource, and whether it succeeded). Use the list endpoint with filters to query by actor, resource type, action, outcome, or date range. Results are paginated and ordered by `created_at` descending. name: Audit Logs paths: /orgs/onboarding: get: tags: - Server Management summary: Get Organization Onboarding Status description: >- Get the setup checklist state for the caller's organization. Each step latches the first time it is satisfied, so a check never reverts. Once every check passes, `show_setup_checklist` on /userinfo turns false — the signal to stop calling this endpoint. responses: '200': content: application/json: schema: $ref: '#/components/schemas/openapi.OrgOnboardingResponse' description: OK '500': content: application/json: schema: $ref: '#/components/schemas/openapi.HTTPError' description: Internal Server Error components: schemas: openapi.OrgOnboardingResponse: properties: checks: allOf: - $ref: '#/components/schemas/openapi.OrgOnboardingChecks' description: The live state of each checklist item completed: description: |- Whether onboarding is finished. Terminal: stays true even if an individual check later regresses type: boolean exec_connection_name: description: >- First web-terminal capable connection, for the "Run your first session" shortcut; null when the organization has none example: pgdemo type: string first_connection_name: description: >- First connection of any kind, the native-access fallback for the same shortcut; null when the organization has no connections example: pgdemo type: string type: object openapi.HTTPError: properties: message: example: the error description type: string type: object openapi.OrgOnboardingChecks: properties: agent_deployed: description: At least one standard agent is currently connected type: boolean ai_analyzer_enabled: description: An AI provider is configured for the session analyzer feature type: boolean data_masking_explored: description: >- At least one user-created data masking rule exists (profile-managed rules don't count) type: boolean groups_created: description: At least one group beyond the built-in admin group exists type: boolean guardrails_explored: description: >- At least one user-created guardrail rule exists (profile-managed rules don't count) type: boolean people_assigned: description: At least one user belongs to a group beyond the built-in admin group type: boolean protection_level_set: description: The organization has a default protection profile type: boolean resource_created: description: The organization has at least one connection type: boolean session_ran: description: The organization has run at least one session type: boolean type: object ````