Idps

Get external idps list

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

200

Executed successfully.

application/json

aliasstringRequiredPattern: ^[a-z0-9_-]+$

typestring · enumRequiredPossible values:

redirectUristringRequired

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get/api/v1/idps

HTTPcURLJavaScriptPython

GET /api/v1/idps HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "alias": "saml",
    "type": "saml",
    "redirectUri": "https://domain/auth/realms/name/broker/saml/endpoint",
    "samlData": {
      "signingCertificate": "signingCertificateExample",
      "singleSignOnServiceUrl": "https://authhost/protocol/saml",
      "entityId": "example.run.ai/runai",
      "serviceProviderMetadataUrl": "https://example.runai.com/auth/realms/runai/broker/saml/endpoint/descriptor"
    },
    "mappers": {
      "gid": "GID",
      "groups": "GROUPS",
      "supplementaryGroups": "SUPPLEMENTARYGROUPS",
      "uid": "UID",
      "email": "email"
    }
  }
]

Configure external idp

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

namestring · max: 255Optional

typestring · enumRequiredPossible values:

Responses

201

Executed successfully.

application/json

aliasstringRequired

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

409

The specified resource already exists

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post/api/v1/idps

HTTPcURLJavaScriptPython

POST /api/v1/idps HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "type": "saml",
  "samlData": {
    "metadataXmlType": "url",
    "metadataXmlUrl": "https://authhost/saml/metadata.xml"
  },
  "mappers": {
    "gid": "GID",
    "groups": "GROUPS",
    "supplementaryGroups": "SUPPLEMENTARYGROUPS",
    "uid": "UID",
    "email": "email"
  }
}

saml (by url)saml (by file)oidcopenshift-v4

{
  "alias": "oidc"
}

Get external idp by alias

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

idpstringRequired

The alias of the idp

Responses

200

Executed successfully.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get/api/v1/idps/{idp}

HTTPcURLJavaScriptPython

GET /api/v1/idps/{idp} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "alias": "saml",
  "type": "saml",
  "redirectUri": "https://domain/auth/realms/name/broker/saml/endpoint",
  "samlData": {
    "signingCertificate": "signingCertificateExample",
    "singleSignOnServiceUrl": "https://authhost/protocol/saml",
    "entityId": "example.run.ai/runai",
    "serviceProviderMetadataUrl": "https://example.runai.com/auth/realms/runai/broker/saml/endpoint/descriptor"
  },
  "mappers": {
    "gid": "GID",
    "groups": "GROUPS",
    "supplementaryGroups": "SUPPLEMENTARYGROUPS",
    "uid": "UID",
    "email": "email"
  }
}

Update external idp by alias

put

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

idpstringRequired

The alias of the idp

Body

application/json

namestring · max: 255Optional

typestring · enumRequiredPossible values:

Responses

200

Idp successfully updated

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

put/api/v1/idps/{idp}

HTTPcURLJavaScriptPython

PUT /api/v1/idps/{idp} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "type": "saml",
  "samlData": {
    "metadataXmlType": "url",
    "metadataXmlUrl": "https://authhost/saml/metadata.xml"
  },
  "mappers": {
    "gid": "GID",
    "groups": "GROUPS",
    "supplementaryGroups": "SUPPLEMENTARYGROUPS",
    "uid": "UID",
    "email": "email"
  }
}

saml (by url)saml (by file)oidcopenshift-v4

No content

Delete external idp by alias

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

idpstringRequired

The alias of the idp

Responses

200

Idp successfully deleted

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

delete/api/v1/idps/{idp}

HTTPcURLJavaScriptPython

DELETE /api/v1/idps/{idp} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get idp mappers

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

idpstringRequired

The alias of the idp

Responses

200

Executed successfully.

application/json

gidstring · max: 255Optional

uidstring · max: 255Optional

groupsstring · max: 255Optional

supplementaryGroupsstring · max: 255Optional

emailstring · max: 254Optional

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get/api/v1/idps/{idp}/mappers

HTTPcURLJavaScriptPython

GET /api/v1/idps/{idp}/mappers HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "gid": "text",
  "uid": "text",
  "groups": "text",
  "supplementaryGroups": "text",
  "email": "text"
}

Update idp mappers

put

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

idpstringRequired

The alias of the idp

Body

application/json

gidstring · max: 255Optional

uidstring · max: 255Optional

groupsstring · max: 255Optional

supplementaryGroupsstring · max: 255Optional

emailstring · max: 254Optional

Responses

202

Request accepted successfully.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

put/api/v1/idps/{idp}/mappers

HTTPcURLJavaScriptPython

PUT /api/v1/idps/{idp}/mappers HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "gid": "text",
  "uid": "text",
  "groups": "text",
  "supplementaryGroups": "text",
  "email": "text"
}

No content