Identity

An identity.

Create an identity provider

Create a new identity provider.

SecurityJWT

Request

Request Body schema: application/json

A JSON object containing identity provider information.

name required	string <= 1000 characters The name of the identity provider.
issuer required	string <uri, https://> <= 1000 characters The issuer of the identity provider.
client_id required	string <= 1000 characters The client id of the identity provider.
client_secret required	string <= 1000 characters The client secret of the identity provider.
discovery	boolean Default: true The discovery flag of the identity provider. The provider must be configured manually if discovery is disabled.
provisioning	boolean Default: true The provisioning flag of the identity provider.
authorization_endpoint	string or null <uri, https://> <= 1000 characters The authorization endpoint of the identity provider. Needs to be set manually if `discovery` is set to `false`.
token_endpoint	string or null <uri, https://> <= 1000 characters The token endpoint of the identity provider. Needs to be set manually if `discovery` is set to `false`.
userinfo_endpoint	string or null <uri, https://> <= 1000 characters The userinfo endpoint of the identity provider. Needs to be set manually if `discovery` is set to `false`.
jwks_uri	string or null <uri, https://> <= 1000 characters The jwks uri of the identity provider. Needs to be set manually if `discovery` is set to `false`.
prompt	boolean Default: true The prompt flag of the identity provider.
type	integer Default: 1 The provider type of the identity. 1 - OIDC Value: 1
status	integer Default: 0 The status of the identity provider. 0 - Disabled 1 - Active Enum: 0 1

Responses

201

Successful operation

422

Unprocessable Content

post/identityprovider

Request samples

Payload
curl

application/json

{"name": "Entra",
"issuer": "https://login.foobar.com/lpo8aqwf-mrc3-vsjx-eiby-zqeq2cnfklrl/v2.0",
"client_id": "85158f4c-eb23-4476-800a-c2286636dec9",
"client_secret": "kgxq3k~6kciwsmmeeccr9uv_wzbjlhryluc7xur0"
}

Response samples

application/json

{"success": true,
"hash": "b0393b97aa5acd983ee5a7f47796bb6ffcd766a5",
"data": {"id": 2,
"hash": "26449e0a9c714a1566a1ead9815ad40e3a33fab0",
"name": "Entra",
"issuer": "https://login.foobar.com/lpo8aqwf-mrc3-vsjx-eiby-zqeq2cnfklrl/v2.0",
"settings": {"client_id": "85158f4c-eb23-4476-800a-c2286636dec9",
"discovery": true,
"provisioning": true,
"authorization_endpoint": null,
"token_endpoint": null,
"userinfo_endpoint": null,
"jwks_uri": null,
"prompt": true
},
"type": 1,
"status": 1,
"created_time": "2025-03-31T09:58:01.000000Z",
"modified_time": "2025-03-31T09:58:01.000000Z",
"modified_user_time": "2025-03-31T09:58:01.000000Z",
"model": "IdentityProvider",
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1751554123257
}

Get all identity providers

Get all identity providers of the authenticated user.

SecurityJWT

Request

query Parameters

page	integer Default: 1 The page number of the response.

Responses

200

Successful operation

404

Not Found

get/identityprovider

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "f8334f8fc60a314fc3af118c03ed45556b1c04b5",
"data": [{"id": 108,
"hash": "26449e0a9c714a1566a1ead9815ad40e3a33fab0",
"name": "Entra",
"issuer": "https://login.foobar.com/lpo8aqwf-mrc3-vsjx-eiby-zqeq2cnfklrl/v2.0",
"settings": {"client_id": "85158f4c-eb23-4476-800a-c2286636dec9",
"discovery": true,
"provisioning": true,
"authorization_endpoint": null,
"token_endpoint": null,
"userinfo_endpoint": null,
"jwks_uri": null,
"prompt": true
},
"type": 1,
"status": 1,
"created_time": "2022-07-20T13:30:49.000000Z",
"modified_time": "2022-07-20T13:30:49.000000Z",
"modified_user_time": "2022-07-20T13:30:49.000000Z",
"model": "IdentityProvider",
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
}
],
"meta": {"page": 1,
"first": 1,
"last": 1,
"total": 1,
"limit": 1000,
"pages": 1
},
"timestamp": 1662388450027
}

Get an identity provider

Get an identity provider.

SecurityJWT

Request

path Parameters

identityprovider

required

string or integer

The id/hash of the identity provider.

Responses

200

Successful operation

404

Not Found

get/identityprovider/{identityprovider}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "b0393b97aa5acd983ee5a7f47796bb6ffcd766a5",
"data": {"id": 2,
"hash": "26449e0a9c714a1566a1ead9815ad40e3a33fab0",
"name": "Entra",
"issuer": "https://login.foobar.com/lpo8aqwf-mrc3-vsjx-eiby-zqeq2cnfklrl/v2.0",
"settings": {"client_id": "85158f4c-eb23-4476-800a-c2286636dec9",
"discovery": true,
"provisioning": true,
"authorization_endpoint": null,
"token_endpoint": null,
"userinfo_endpoint": null,
"jwks_uri": null,
"prompt": true
},
"type": 1,
"status": 1,
"created_time": "2025-03-31T09:58:01.000000Z",
"modified_time": "2025-03-31T09:58:01.000000Z",
"modified_user_time": "2025-03-31T09:58:01.000000Z",
"model": "IdentityProvider",
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1743417343073
}

Update an identity provider

Update an identity provider.

SecurityJWT

Request

path Parameters

identityprovider

required

string or integer

The id/hash of the identity provider.

Request Body schema: application/json

A JSON object containing identity provider information.

name	string <= 1000 characters The name of the identity provider.
issuer	string <uri, https://> <= 1000 characters The issuer of the identity provider.
client_id	string <= 1000 characters The client id of the identity provider.
client_secret	string <= 1000 characters The client secret of the identity provider.
discovery	boolean Default: true The discovery flag of the identity provider. The provider must be configured manually if discovery is disabled.
provisioning	boolean Default: true The provisioning flag of the identity provider.
authorization_endpoint	string or null <uri, https://> <= 1000 characters The authorization endpoint of the identity provider. Needs to be set manually if `discovery` is set to `false`.
token_endpoint	string or null <uri, https://> <= 1000 characters The token endpoint of the identity provider. Needs to be set manually if `discovery` is set to `false`.
userinfo_endpoint	string or null <uri, https://> <= 1000 characters The userinfo endpoint of the identity provider. Needs to be set manually if `discovery` is set to `false`.
jwks_uri	string or null <uri, https://> <= 1000 characters The jwks uri of the identity provider. Needs to be set manually if `discovery` is set to `false`.
prompt	boolean Default: true The prompt flag of the identity provider.
type	integer Default: 1 The provider type of the identity. 1 - OIDC Value: 1
status	integer Default: 0 The status of the identity provider. 0 - Disabled 1 - Active Enum: 0 1

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

put/identityprovider/{identityprovider}

Request samples

Payload
curl

application/json

{"name": "Microsoft",
"issuer": "https://login.microsoft.com/4hb7qpl5-5wwc-tpo3-y8lc-irauhy0l0lna/v2.0"
}

Response samples

application/json

{"success": true,
"hash": "b0393b97aa5acd983ee5a7f47796bb6ffcd766a5",
"data": {"id": 2,
"hash": "26449e0a9c714a1566a1ead9815ad40e3a33fab0",
"name": "Microsoft",
"issuer": "https://login.microsoft.com/4hb7qpl5-5wwc-tpo3-y8lc-irauhy0l0lna/v2.0",
"settings": {"client_id": "85158f4c-eb23-4476-800a-c2286636dec9",
"discovery": true,
"provisioning": true,
"authorization_endpoint": null,
"token_endpoint": null,
"userinfo_endpoint": null,
"jwks_uri": null,
"prompt": true
},
"type": 1,
"status": 1,
"created_time": "2025-03-31T09:58:01.000000Z",
"modified_time": "2025-07-03T15:22:56.000000Z",
"modified_user_time": "2025-07-03T15:22:56.000000Z",
"model": "IdentityProvider",
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-23T12:18:17.000000Z",
"modified_user_time": "2022-05-23T12:18:17.000000Z",
"model": "User"
}
},
"timestamp": 1751556176043
}

Delete an identity provider

Delete an identity provider.

SecurityJWT

Request

path Parameters

identityprovider

required

string or integer

The id/hash of the identity provider.

Responses

200

Successful operation

404

Not Found

delete/identityprovider/{identityprovider}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "97d170e1550eee4afc0af065b78cda302a97674c",
"data": { },
"timestamp": 1751557396363
}

Clear an identity provider

Clear the cache for an identity provider.

SecurityJWT

Request

path Parameters

identityprovider

required

string or integer

The id/hash of the identity provider.

Responses

200

Successful operation

404

Not Found

post/identityprovider/{identityprovider}/clear

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "97d170e1550eee4afc0af065b78cda302a97674c",
"data": { },
"timestamp": 1751968770400
}

➔ Next to Image