> 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/2.26/authentication-and-authorization/idps.md).

# Idps

## GET /api/v1/idps

> Get external idps list

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.26"},"tags":[{"name":"Idps"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"Idps":{"type":"array","minItems":0,"maxItems":100,"items":{"$ref":"#/components/schemas/Idp"}},"Idp":{"type":"object","required":["alias","type","redirectUri"],"properties":{"alias":{"type":"string","pattern":"^[a-z0-9_-]+$"},"type":{"type":"string","enum":["saml","oidc","openshift-v4"]},"redirectUri":{"type":"string"},"samlData":{"$ref":"#/components/schemas/SamlData"},"oidcData":{"$ref":"#/components/schemas/OidcData"},"ocpData":{"$ref":"#/components/schemas/OcpData"},"mappers":{"$ref":"#/components/schemas/Mappers"}}},"SamlData":{"type":"object","nullable":true,"properties":{"signingCertificate":{"type":"string"},"singleSignOnServiceUrl":{"type":"string"},"entityId":{"type":"string"},"serviceProviderMetadataUrl":{"type":"string","description":"Service Provider (SP) metadata url"}}},"OidcData":{"type":"object","nullable":true,"required":["clientId","clientSecret","discoverDocumentUrl"],"properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"scopes":{"type":"array","items":{"type":"string","pattern":"^([a-zA-Z0-9-._:]+)(\\s[a-zA-Z0-9-._:]+)*$"}},"mandatoryClaim":{"$ref":"#/components/schemas/MandatoryClaim"}}},"MandatoryClaim":{"type":"object","nullable":true,"required":["claim","values"],"properties":{"claim":{"type":"string","pattern":".*[a-zA-Z].*","minLength":1,"maxLength":255},"values":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1,"maxLength":255,"pattern":"^(?!.*\\s).*?[a-zA-Z].*$"}}}},"OcpData":{"type":"object","nullable":true,"properties":{"idpBaseUrl":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}}}},"Mappers":{"type":"object","required":["alias"],"properties":{"gid":{"type":"string","maxLength":255},"uid":{"type":"string","maxLength":255},"groups":{"type":"string","maxLength":255},"supplementaryGroups":{"type":"string","maxLength":255},"email":{"type":"string","maxLength":254},"firstName":{"type":"string","maxLength":255},"lastName":{"type":"string","maxLength":255}}},"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/idps":{"get":{"summary":"Get external idps list","operationId":"get_idps","tags":["Idps"],"responses":{"200":{"description":"Executed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Idps"}}}},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## POST /api/v1/idps

> Configure external idp

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.26"},"tags":[{"name":"Idps"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"IdpCreationRequest":{"type":"object","required":["type","data"],"properties":{"name":{"type":"string","maxLength":255},"type":{"allOf":[{"$ref":"#/components/schemas/IdpCreationRequestTypeEnum"}]},"samlData":{"$ref":"#/components/schemas/SamlCreationData"},"oidcData":{"$ref":"#/components/schemas/OidcCreationData"},"ocpData":{"$ref":"#/components/schemas/OcpCreationData"},"mappers":{"$ref":"#/components/schemas/Mappers"}}},"IdpCreationRequestTypeEnum":{"type":"string","enum":["oidc","saml","openshift-v4"]},"SamlCreationData":{"type":"object","nullable":true,"properties":{"metadataXmlUrl":{"type":"string","pattern":"/^(https?://)?([a-zA-Z0-9.-]+\\.[a-zA-Z]{2,})(:[0-9]{1,5})?(/[^\\s]*)?$|^$/","maxLength":2048},"metadataXmlFile":{"type":"string","maxLength":100000},"fileName":{"type":"string","maxLength":255},"metadataXmlType":{"allOf":[{"$ref":"#/components/schemas/SamlCreationDataMetadataXmlTypeEnum"}]},"entityId":{"type":"string","maxLength":2048}}},"SamlCreationDataMetadataXmlTypeEnum":{"type":"string","enum":["url","file"]},"OidcCreationData":{"type":"object","nullable":true,"required":["clientId","clientSecret","discoverDocumentUrl"],"properties":{"clientId":{"type":"string","minLength":1,"maxLength":255},"clientSecret":{"type":"string","minLength":1,"maxLength":500},"discoverDocumentUrl":{"type":"string","pattern":"/^(https?://)?([a-zA-Z0-9.-]+\\.[a-zA-Z]{2,})(:[0-9]{1,5})?(/[^\\s]*)?$|^$/","maxLength":2048},"scopes":{"type":"array","minItems":0,"maxItems":50,"items":{"type":"string","pattern":"^([a-zA-Z0-9-._:]+)(\\s[a-zA-Z0-9-._:]+)*$","minLength":1,"maxLength":100}},"mandatoryClaim":{"$ref":"#/components/schemas/MandatoryClaim"}}},"MandatoryClaim":{"type":"object","nullable":true,"required":["claim","values"],"properties":{"claim":{"type":"string","pattern":".*[a-zA-Z].*","minLength":1,"maxLength":255},"values":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1,"maxLength":255,"pattern":"^(?!.*\\s).*?[a-zA-Z].*$"}}}},"OcpCreationData":{"type":"object","nullable":true,"required":["idpBaseUrl","clientSecret"],"properties":{"clientId":{"type":"string","minLength":1,"maxLength":255},"idpBaseUrl":{"type":"string","pattern":"/^(https?://)?([a-zA-Z0-9.-]+\\.[a-zA-Z]{2,})(:[0-9]{1,5})?(/[^\\s]*)?$|^$/","maxLength":2048},"clientSecret":{"type":"string","minLength":1,"maxLength":500},"scopes":{"type":"array","minItems":0,"maxItems":50,"items":{"type":"string","pattern":"^([a-zA-Z0-9-._:]+)(\\s[a-zA-Z0-9-._:]+)*$","minLength":1,"maxLength":100}}}},"Mappers":{"type":"object","required":["alias"],"properties":{"gid":{"type":"string","maxLength":255},"uid":{"type":"string","maxLength":255},"groups":{"type":"string","maxLength":255},"supplementaryGroups":{"type":"string","maxLength":255},"email":{"type":"string","maxLength":254},"firstName":{"type":"string","maxLength":255},"lastName":{"type":"string","maxLength":255}}},"IdpPostResponse":{"type":"object","required":["alias"],"properties":{"alias":{"type":"string"}}},"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"}}}},"409Conflict":{"description":"The specified resource already exists","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/idps":{"post":{"summary":"Configure external idp","operationId":"create_idp","tags":["Idps"],"requestBody":{"description":"Idp configuration","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdpCreationRequest"}}}},"responses":{"201":{"description":"Executed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdpPostResponse"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"409":{"$ref":"#/components/responses/409Conflict"},"500":{"$ref":"#/components/responses/500InternalServerError"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## GET /api/v1/idps/{idp}

> Get external idp by alias

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.26"},"tags":[{"name":"Idps"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"idp":{"name":"idp","in":"path","required":true,"description":"The alias of the idp","schema":{"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"}}}},"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"}}}}},"schemas":{"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}}},"paths":{"/api/v1/idps/{idp}":{"get":{"summary":"Get external idp by alias","operationId":"get_idp","tags":["Idps"],"parameters":[{"$ref":"#/components/parameters/idp"}],"responses":{"200":{"description":"Executed successfully.","content":{"application/json":{}}},"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/idps/{idp}

> Update external idp by alias

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.26"},"tags":[{"name":"Idps"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"idp":{"name":"idp","in":"path","required":true,"description":"The alias of the idp","schema":{"type":"string"}}},"schemas":{"IdpCreationRequest":{"type":"object","required":["type","data"],"properties":{"name":{"type":"string","maxLength":255},"type":{"allOf":[{"$ref":"#/components/schemas/IdpCreationRequestTypeEnum"}]},"samlData":{"$ref":"#/components/schemas/SamlCreationData"},"oidcData":{"$ref":"#/components/schemas/OidcCreationData"},"ocpData":{"$ref":"#/components/schemas/OcpCreationData"},"mappers":{"$ref":"#/components/schemas/Mappers"}}},"IdpCreationRequestTypeEnum":{"type":"string","enum":["oidc","saml","openshift-v4"]},"SamlCreationData":{"type":"object","nullable":true,"properties":{"metadataXmlUrl":{"type":"string","pattern":"/^(https?://)?([a-zA-Z0-9.-]+\\.[a-zA-Z]{2,})(:[0-9]{1,5})?(/[^\\s]*)?$|^$/","maxLength":2048},"metadataXmlFile":{"type":"string","maxLength":100000},"fileName":{"type":"string","maxLength":255},"metadataXmlType":{"allOf":[{"$ref":"#/components/schemas/SamlCreationDataMetadataXmlTypeEnum"}]},"entityId":{"type":"string","maxLength":2048}}},"SamlCreationDataMetadataXmlTypeEnum":{"type":"string","enum":["url","file"]},"OidcCreationData":{"type":"object","nullable":true,"required":["clientId","clientSecret","discoverDocumentUrl"],"properties":{"clientId":{"type":"string","minLength":1,"maxLength":255},"clientSecret":{"type":"string","minLength":1,"maxLength":500},"discoverDocumentUrl":{"type":"string","pattern":"/^(https?://)?([a-zA-Z0-9.-]+\\.[a-zA-Z]{2,})(:[0-9]{1,5})?(/[^\\s]*)?$|^$/","maxLength":2048},"scopes":{"type":"array","minItems":0,"maxItems":50,"items":{"type":"string","pattern":"^([a-zA-Z0-9-._:]+)(\\s[a-zA-Z0-9-._:]+)*$","minLength":1,"maxLength":100}},"mandatoryClaim":{"$ref":"#/components/schemas/MandatoryClaim"}}},"MandatoryClaim":{"type":"object","nullable":true,"required":["claim","values"],"properties":{"claim":{"type":"string","pattern":".*[a-zA-Z].*","minLength":1,"maxLength":255},"values":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","minLength":1,"maxLength":255,"pattern":"^(?!.*\\s).*?[a-zA-Z].*$"}}}},"OcpCreationData":{"type":"object","nullable":true,"required":["idpBaseUrl","clientSecret"],"properties":{"clientId":{"type":"string","minLength":1,"maxLength":255},"idpBaseUrl":{"type":"string","pattern":"/^(https?://)?([a-zA-Z0-9.-]+\\.[a-zA-Z]{2,})(:[0-9]{1,5})?(/[^\\s]*)?$|^$/","maxLength":2048},"clientSecret":{"type":"string","minLength":1,"maxLength":500},"scopes":{"type":"array","minItems":0,"maxItems":50,"items":{"type":"string","pattern":"^([a-zA-Z0-9-._:]+)(\\s[a-zA-Z0-9-._:]+)*$","minLength":1,"maxLength":100}}}},"Mappers":{"type":"object","required":["alias"],"properties":{"gid":{"type":"string","maxLength":255},"uid":{"type":"string","maxLength":255},"groups":{"type":"string","maxLength":255},"supplementaryGroups":{"type":"string","maxLength":255},"email":{"type":"string","maxLength":254},"firstName":{"type":"string","maxLength":255},"lastName":{"type":"string","maxLength":255}}},"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/idps/{idp}":{"put":{"summary":"Update external idp by alias","operationId":"update_idp","tags":["Idps"],"parameters":[{"$ref":"#/components/parameters/idp"}],"requestBody":{"description":"Updated idp object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdpCreationRequest"}}}},"responses":{"200":{"description":"Idp 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"}}}}}}
```

## DELETE /api/v1/idps/{idp}

> Delete external idp by alias

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.26"},"tags":[{"name":"Idps"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"idp":{"name":"idp","in":"path","required":true,"description":"The alias of the idp","schema":{"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"}}}},"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"}}}}},"schemas":{"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}}},"paths":{"/api/v1/idps/{idp}":{"delete":{"summary":"Delete external idp by alias","operationId":"delete_idp","tags":["Idps"],"parameters":[{"$ref":"#/components/parameters/idp"}],"responses":{"200":{"description":"Idp successfully deleted"},"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/v1/idps/{idp}/mappers

> Get idp mappers

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.26"},"tags":[{"name":"Idps"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"idp":{"name":"idp","in":"path","required":true,"description":"The alias of the idp","schema":{"type":"string"}}},"schemas":{"Mappers":{"type":"object","required":["alias"],"properties":{"gid":{"type":"string","maxLength":255},"uid":{"type":"string","maxLength":255},"groups":{"type":"string","maxLength":255},"supplementaryGroups":{"type":"string","maxLength":255},"email":{"type":"string","maxLength":254},"firstName":{"type":"string","maxLength":255},"lastName":{"type":"string","maxLength":255}}},"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"}}}},"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/idps/{idp}/mappers":{"get":{"summary":"Get idp mappers","operationId":"get_idp_mappers","tags":["Idps"],"parameters":[{"$ref":"#/components/parameters/idp"}],"responses":{"200":{"description":"Executed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mappers"}}}},"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/idps/{idp}/mappers

> Update idp mappers

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.26"},"tags":[{"name":"Idps"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"idp":{"name":"idp","in":"path","required":true,"description":"The alias of the idp","schema":{"type":"string"}}},"schemas":{"Mappers":{"type":"object","required":["alias"],"properties":{"gid":{"type":"string","maxLength":255},"uid":{"type":"string","maxLength":255},"groups":{"type":"string","maxLength":255},"supplementaryGroups":{"type":"string","maxLength":255},"email":{"type":"string","maxLength":254},"firstName":{"type":"string","maxLength":255},"lastName":{"type":"string","maxLength":255}}},"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"}}}},"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/idps/{idp}/mappers":{"put":{"summary":"Update idp mappers","operationId":"update_idp_mappers","tags":["Idps"],"parameters":[{"$ref":"#/components/parameters/idp"}],"requestBody":{"description":"Map of our mappers and their source in the external idp","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mappers"}}}},"responses":{"202":{"description":"Request accepted successfully."},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://run-ai-docs.nvidia.com/api/2.26/authentication-and-authorization/idps.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
