Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NVIDIA Run:ai Idps API

The Idps API from NVIDIA Run:ai — 3 operation(s) for idps.

NVIDIA Run:ai Idps API is one of 62 APIs that NVIDIA Run:ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Idps. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 7 operations across 3 paths, and defines 15 schemas. It is described by OpenAPI 3.0.3, at version latest.

Requests are made against a single base URL, https://app.run.ai.

7 operations 3 paths 15 schemas 1 DELETE3 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
latest
Base URL
https://app.run.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

NVIDIA Run:ai Idps API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer authentication

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Idps 7
GET
/api/v1/idps
Get external idps list
get_idps → 200401403500503
POST
/api/v1/idps
Configure external idp
create_idp body → 201400401403404409500503
GET
/api/v1/idps/{idp}
Get external idp by alias
get_idp 1 param → 200401403404500503
DELETE
/api/v1/idps/{idp}
Delete external idp by alias
delete_idp 1 param → 200401403404500503
PUT
/api/v1/idps/{idp}
Update external idp by alias
update_idp 1 param body → 200400401403404500503
GET
/api/v1/idps/{idp}/mappers
Get idp mappers
get_idp_mappers 1 param → 200401403404500503
PUT
/api/v1/idps/{idp}/mappers
Update idp mappers
update_idp_mappers 1 param body → 202400401403500503

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Idp1 (7 properties), IdpCreationRequest (6 properties), OidcCreationData (5 properties), SamlCreationData (5 properties). Each schema is shown below with its type and property counts.

Idp1
object
7 properties 3 required
SamlCreationDataMetadataXmlTypeEnum
string
Idps
array
Error
object
3 properties 2 required
OidcCreationData
object
5 properties 3 required
OcpData
object
4 properties
OcpCreationData
object
4 properties 2 required
IdpPostResponse
object
1 property 1 required
SamlCreationData
object
5 properties
MandatoryClaim
object
2 properties 2 required
OidcData
object
4 properties 3 required
Mappers
object
5 properties 1 required
SamlData
object
4 properties
IdpCreationRequest
object
6 properties 2 required
IdpCreationRequestTypeEnum
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runai-idps-api-openapi.yml Raw ↑

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access Keys API
NVIDIA Run:ai Access rules API
NVIDIA Run:ai Administrator Command Line Interface API
NVIDIA Run:ai AI Applications API
NVIDIA Run:ai Applications API
NVIDIA Run:ai AuditLogs API
NVIDIA Run:ai Clusters API
NVIDIA Run:ai Compute API
NVIDIA Run:ai ConfigMap API
NVIDIA Run:ai Credentials API
NVIDIA Run:ai Datasources API
NVIDIA Run:ai Datavolumes API