Ctrlk
Contact support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Idps

Get external idps list

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
tenantIdstringOptional

If exists will return the relevant resource for the tenant ID

Default: ""Example: 1008
Responses
200

Executed successfully.

application/json
aliasstringRequiredPattern: ^[a-z0-9_-]+$
typestring · enumRequiredPossible values:
redirectUristringRequired
get/api/v1/idps
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
AuthorizationstringRequired

Bearer authentication

Query parameters
tenantIdstringOptional

If exists will return the relevant resource for the tenant ID

Default: ""Example: 1008
Body
namestring · max: 255Optional
typestring · enumRequiredPossible values:
Responses
201

Executed successfully.

application/json
aliasstringRequired
post/api/v1/idps
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"
  }
}
{
  "alias": "oidc"
}

Get external idp by alias

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
idpstringRequired

The alias of the idp

Query parameters
tenantIdstringOptional

If exists will return the relevant resource for the tenant ID

Default: ""Example: 1008
Responses
200

Executed successfully.

application/json
get/api/v1/idps/{idp}
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
AuthorizationstringRequired

Bearer authentication

Path parameters
idpstringRequired

The alias of the idp

Query parameters
tenantIdstringOptional

If exists will return the relevant resource for the tenant ID

Default: ""Example: 1008
Body
namestring · max: 255Optional
typestring · enumRequiredPossible values:
Responses
200

Idp successfully updated

No content
put/api/v1/idps/{idp}
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"
  }
}
No content

Delete external idp by alias

delete
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
idpstringRequired

The alias of the idp

Query parameters
tenantIdstringOptional

If exists will return the relevant resource for the tenant ID

Default: ""Example: 1008
Responses
200

Idp successfully deleted

No content
delete/api/v1/idps/{idp}
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
AuthorizationstringRequired

Bearer authentication

Path parameters
idpstringRequired

The alias of the idp

Query parameters
tenantIdstringOptional

If exists will return the relevant resource for the tenant ID

Default: ""Example: 1008
Responses
200

Executed successfully.

application/json
gidstring · max: 255Optional
uidstring · max: 255Optional
groupsstring · max: 255Optional
supplementaryGroupsstring · max: 255Optional
emailstring · max: 254Optional
get/api/v1/idps/{idp}/mappers
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
AuthorizationstringRequired

Bearer authentication

Path parameters
idpstringRequired

The alias of the idp

Query parameters
tenantIdstringOptional

If exists will return the relevant resource for the tenant ID

Default: ""Example: 1008
Body
gidstring · max: 255Optional
uidstring · max: 255Optional
groupsstring · max: 255Optional
supplementaryGroupsstring · max: 255Optional
emailstring · max: 254Optional
Responses
202

Request accepted successfully.

No content
put/api/v1/idps/{idp}/mappers
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
PreviousUser ApplicationsNextMe

Last updated