> For the complete documentation index, see [llms.txt](https://detected.gitbook.io/detected-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://detected.gitbook.io/detected-docs/api-reference/onboarding-portal-configurations.md).

# Onboarding Portal Configurations

Portal configurations are created in the platform and define the onboarding steps required in the onboarding portal. Configurations are assigned automatically and can also be assigned to a profile by API. Please see the Profiles section for more information.

## List portal configurations

> Returns all the onboarding portal configurations for your account. To change the configuration assigned to a profile, pass a configuration's ID as \`configuration\_id\` to \*\*Update a profile\*\* (\`PATCH /profiles/{uuid}\`).

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"tags":[{"name":"Onboarding Portal Configurations","description":"Portal configurations are created in the platform and define the onboarding steps required in the onboarding portal. Configurations are assigned automatically and can also be assigned to a profile by API. Please see the Profiles section for more information."}],"servers":[{"url":"https://api.detected.app/api/v2/public","description":"Production"}],"security":[{"AccessToken":[]}],"components":{"securitySchemes":{"AccessToken":{"type":"http","description":"The API uses OAuth 2.0. Request an access token with **Create an access token** (`POST /oauth/token`), sending the client ID and client secret of your integration client, and your account slug. Send the access token in the `Authorization` header of every request, in the format `Authorization: Bearer <access_token>`. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.","bearerFormat":"OAuth 2.0 access token","scheme":"bearer"}},"headers":{"X-RateLimit-Limit":{"description":"Maximum number of requests allowed in the rate limit window.","schema":{"type":"number","nullable":false}},"X-RateLimit-Remaining":{"description":"Number of requests remaining in the current rate limit window.","schema":{"type":"number","nullable":false}},"Retry-After":{"description":"Number of seconds to wait before making another request. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}},"X-RateLimit-Reset":{"description":"Unix timestamp (in seconds) at which the rate limit resets. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}}},"schemas":{"PortalConfigurationResponse":{"title":"Portal Configuration Resource","required":["id","name","updated_at","created_at"],"properties":{"id":{"description":"Portal configuration ID.","type":"number","nullable":false},"name":{"description":"Portal configuration name.","type":"string","nullable":false},"updated_at":{"description":"Date and time the portal configuration was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the portal configuration was created.","type":"string","nullable":false}},"type":"object"}},"responses":{"401":{"description":"Unauthorized. The access token is missing, invalid or has expired.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}},"429":{"description":"Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the `Retry-After` header before trying again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}}}},"paths":{"/portal-configurations":{"get":{"tags":["Onboarding Portal Configurations"],"summary":"List portal configurations","description":"Returns all the onboarding portal configurations for your account. To change the configuration assigned to a profile, pass a configuration's ID as `configuration_id` to **Update a profile** (`PATCH /profiles/{uuid}`).","operationId":"7c516bba53bf008a904b5d2160d349f9","parameters":[{"name":"id","in":"query","description":"Filter by portal configuration ID. If a match is found, only that configuration is returned.","schema":{"type":"integer"}},{"name":"name","in":"query","description":"Filter by portal configuration name.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"properties":{"data":{"description":"The portal configurations for your account.","type":"array","items":{"$ref":"#/components/schemas/PortalConfigurationResponse"}}},"type":"object"}}}},"401":{"$ref":"#/components/responses/401"},"429":{"$ref":"#/components/responses/429"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://detected.gitbook.io/detected-docs/api-reference/onboarding-portal-configurations.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.