> For the complete documentation index, see [llms.txt](https://run-ai-docs.nvidia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://run-ai-docs.nvidia.com/api/authentication-and-authorization/settings.md).

# Settings

View and manage configuration settings for your organization.

## GET /api/v1/security/settings

> Get security settings

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"latest"},"tags":[{"name":"Settings","description":"View and manage configuration settings for your organization.\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"SettingsGetResponse":{"type":"object","properties":{"autoRedirectSSO":{"$ref":"#/components/schemas/AutoRedirectSsoSetting"},"browserSessionTimeout":{"$ref":"#/components/schemas/BrowserSessionTimeoutSetting"},"logoutRedirectUri":{"$ref":"#/components/schemas/LogoutRedirectUriSetting"}}},"AutoRedirectSsoSetting":{"type":"object","properties":{"enabled":{"type":"boolean","nullable":true},"idpAlias":{"type":"string","pattern":"^[a-z0-9_-]*$","nullable":true,"maxLength":255}}},"BrowserSessionTimeoutSetting":{"type":"object","description":"Settings for user session timeout configuration that manages automatic logout after periods of inactivity.","properties":{"idleTimeout":{"type":"number","description":"Duration in minutes that a user can remain inactive before their browser session automatically expires and requires re-authentication","default":60,"minimum":1,"maximum":10080,"nullable":true}}},"LogoutRedirectUriSetting":{"type":"object","description":"Settings for configuring the logout redirect URI that determines where users are redirected after logging out.","properties":{"uri":{"type":"string","description":"The URI where users will be redirected after logging out of the application","nullable":true,"pattern":"/^(https?://)?([a-zA-Z0-9.-]+\\.[a-zA-Z]{2,})(:[0-9]{1,5})?(/[^\\s]*)?$|^$/","maxLength":2048}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/security/settings":{"get":{"summary":"Get security settings","operationId":"get_security_settings","tags":["Settings"],"responses":{"200":{"description":"Executed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingsGetResponse"}}}},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## GET /api/v1/security/settings/{key}

> Get security setting by key

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"latest"},"tags":[{"name":"Settings","description":"View and manage configuration settings for your organization.\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"settingsKey":{"name":"key","in":"path","required":true,"description":"The settings key","schema":{"$ref":"#/components/schemas/settingsKeyEnum"}}},"schemas":{"settingsKeyEnum":{"type":"string","enum":["autoRedirectSSO","browserSessionTimeout","logoutRedirectUri"]},"Settings":{"type":"object","additionalProperties":true,"minProperties":0,"maxProperties":50},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/security/settings/{key}":{"get":{"summary":"Get security setting by key","operationId":"get_security_setting_by_key","tags":["Settings"],"parameters":[{"$ref":"#/components/parameters/settingsKey"}],"responses":{"200":{"description":"Executed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Settings"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## PUT /api/v1/security/settings/{key}

> Update security setting by key

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"latest"},"tags":[{"name":"Settings","description":"View and manage configuration settings for your organization.\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"settingsKey":{"name":"key","in":"path","required":true,"description":"The settings key","schema":{"$ref":"#/components/schemas/settingsKeyEnum"}}},"schemas":{"settingsKeyEnum":{"type":"string","enum":["autoRedirectSSO","browserSessionTimeout","logoutRedirectUri"]},"AutoRedirectSsoSetting":{"type":"object","properties":{"enabled":{"type":"boolean","nullable":true},"idpAlias":{"type":"string","pattern":"^[a-z0-9_-]*$","nullable":true,"maxLength":255}}},"BrowserSessionTimeoutSetting":{"type":"object","description":"Settings for user session timeout configuration that manages automatic logout after periods of inactivity.","properties":{"idleTimeout":{"type":"number","description":"Duration in minutes that a user can remain inactive before their browser session automatically expires and requires re-authentication","default":60,"minimum":1,"maximum":10080,"nullable":true}}},"LogoutRedirectUriSetting":{"type":"object","description":"Settings for configuring the logout redirect URI that determines where users are redirected after logging out.","properties":{"uri":{"type":"string","description":"The URI where users will be redirected after logging out of the application","nullable":true,"pattern":"/^(https?://)?([a-zA-Z0-9.-]+\\.[a-zA-Z]{2,})(:[0-9]{1,5})?(/[^\\s]*)?$|^$/","maxLength":2048}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/security/settings/{key}":{"put":{"summary":"Update security setting by key","operationId":"update_security_setting_by_key","tags":["Settings"],"parameters":[{"$ref":"#/components/parameters/settingsKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AutoRedirectSsoSetting"},{"$ref":"#/components/schemas/BrowserSessionTimeoutSetting"},{"$ref":"#/components/schemas/LogoutRedirectUriSetting"}]}}}},"responses":{"200":{"description":"Setting successfully updated"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## GET /api/v2/workloads/settings

> Get workloads settings

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"latest"},"tags":[{"name":"Settings","description":"View and manage configuration settings for your organization.\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"WorkloadsSettingsGetResponse":{"type":"object","properties":{"yamlSubmission":{"$ref":"#/components/schemas/YamlSubmissionSetting"}}},"YamlSubmissionSetting":{"type":"object","properties":{"enabled":{"type":"boolean","nullable":true}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v2/workloads/settings":{"get":{"summary":"Get workloads settings","operationId":"get_workloads_settings","tags":["Settings"],"responses":{"200":{"description":"Executed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkloadsSettingsGetResponse"}}}},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## GET /api/v2/workloads/settings/{key}

> Get workloads setting by key

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"latest"},"tags":[{"name":"Settings","description":"View and manage configuration settings for your organization.\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"WorkloadSettingsKey":{"name":"key","in":"path","required":true,"description":"The settings key","schema":{"$ref":"#/components/schemas/WorkloadsSettingsKeyEnum"}}},"schemas":{"WorkloadsSettingsKeyEnum":{"type":"string","enum":["yamlSubmission"]},"YamlSubmissionSetting":{"type":"object","properties":{"enabled":{"type":"boolean","nullable":true}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v2/workloads/settings/{key}":{"get":{"summary":"Get workloads setting by key","operationId":"get_workloads_setting_by_key","tags":["Settings"],"parameters":[{"$ref":"#/components/parameters/WorkloadSettingsKey"}],"responses":{"200":{"description":"Executed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YamlSubmissionSetting"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## PUT /api/v2/workloads/settings/{key}

> Update workloads setting by key

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"latest"},"tags":[{"name":"Settings","description":"View and manage configuration settings for your organization.\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"WorkloadSettingsKey":{"name":"key","in":"path","required":true,"description":"The settings key","schema":{"$ref":"#/components/schemas/WorkloadsSettingsKeyEnum"}}},"schemas":{"WorkloadsSettingsKeyEnum":{"type":"string","enum":["yamlSubmission"]},"YamlSubmissionSetting":{"type":"object","properties":{"enabled":{"type":"boolean","nullable":true}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v2/workloads/settings/{key}":{"put":{"summary":"Update workloads setting by key","operationId":"update_workloads_setting_by_key","tags":["Settings"],"parameters":[{"$ref":"#/components/parameters/WorkloadSettingsKey"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/YamlSubmissionSetting"}}}},"responses":{"200":{"description":"Setting successfully updated"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```


---

# 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://run-ai-docs.nvidia.com/api/authentication-and-authorization/settings.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.