Run:ai

Idps

Get external idps list

SecuritybearerAuth
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/idps
Response samples
application/json
[]

Configure external idp

SecuritybearerAuth
Request
Request Body schema: application/json
required

Idp configuration

name
string
type
required
string
Enum: "saml" "oidc" "openshift-v4"
object or null (SamlCreationData)
object or null (OidcCreationData)
object or null (OcpCreationData)
object (Mappers)
Responses
201

Executed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

409

The specified resource already exists

500

unexpected error

503

unexpected error

post/api/v1/idps
Request samples
application/json
{
  • "type": "saml",
  • "samlData": {},
  • "mappers": {
    }
}
Response samples
application/json
{
  • "alias": "oidc"
}

Get external idp by alias

SecuritybearerAuth
Request
path Parameters
idp
required
string

The alias of the idp

Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/idps/{idp}
Response samples
application/json
{}

Delete external idp by alias

SecuritybearerAuth
Request
path Parameters
idp
required
string

The alias of the idp

Responses
200

Idp successfully deleted

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

delete/api/v1/idps/{idp}
Response samples
application/json
{
  • "code": 401,
  • "message": "Issuer is not familiar."
}

Update external idp by alias

SecuritybearerAuth
Request
path Parameters
idp
required
string

The alias of the idp

Request Body schema: application/json
required

Updated idp object

name
string
type
required
string
Enum: "saml" "oidc" "openshift-v4"
object or null (SamlCreationData)
object or null (OidcCreationData)
object or null (OcpCreationData)
object (Mappers)
Responses
200

Idp successfully updated

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

put/api/v1/idps/{idp}
Request samples
application/json
{
  • "type": "saml",
  • "samlData": {},
  • "mappers": {
    }
}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}

Get idp mappers

SecuritybearerAuth
Request
path Parameters
idp
required
string

The alias of the idp

Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/idps/{idp}/mappers
Response samples
application/json
{
  • "gid": "string",
  • "uid": "string",
  • "groups": "string",
  • "supplementaryGroups": "string",
  • "email": "string"
}

Update idp mappers

SecuritybearerAuth
Request
path Parameters
idp
required
string

The alias of the idp

Request Body schema: application/json
required

Map of our mappers and their source in the external idp

gid
string
uid
string
groups
string
supplementaryGroups
string
email
string
Responses
202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

put/api/v1/idps/{idp}/mappers
Request samples
application/json
{
  • "gid": "string",
  • "uid": "string",
  • "groups": "string",
  • "supplementaryGroups": "string",
  • "email": "string"
}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}
➔ Next to AuditLogs