The Auth Provider Controller enables management of authentication providers for AdmiralCloud’s OAuth2 authentication server. These endpoints allow you to configure, manage, and integrate various identity providers (IdPs) such as ADFS, Azure AD, or generic SAML providers. This functionality enables Single Sign-On (SSO) capabilities for your applications and streamlines user authentication through your existing identity systems.
Reference
Find AuthProvider
Retrieves information about one or multiple configured authentication providers. Allows searching and filtering of existing auth providers.
GET/v4/authprovider
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| – | ✗ | Ths endpoint does not require or accept any request parameters |
Response
| Field | Type | Description |
|---|---|---|
| deleted | boolean | If true, the authProvider is finally destroyed. |
| flag | integer | Flag of this auth provider (1 = in trash) |
| id | integer | Internal ID |
| issuer | string | Issuer as set in callback response of identity provider |
| lastEditorId | integer | Id of the last editor |
| lastUsed | integer | Unix timestamp of last usage of this authprovider |
| metadata | string | Metadata of identity provider |
| name | string | Chosen name for this auth provider |
| settings | object | Settings for this authProvider |
| └ attributeMapping | object | Mapping of user attributes to AC fields |
| └ entityId | string | Optional entity identifier, e.g. Microsoft Entra Identifier (Azure) |
| └ configuration | object | Old configuration with metadata properties and attribute mapping |
| └ legacy | boolean | DO NOT USE |
| ssoIdentifier | string | Identifier as used in app configuraion |
| type | string | Type of auth, e.g. adfs, azure or generic SAML |
Create AuthProvider
This endpoint allows you to configure a new SSO identity provider. Required parameters include the issuer of the identity provider. Additionally, you can add metadata, a name, and specific settings such as attribute mappings to properly integrate user data into AdmiralCloud.
POST/v4/authprovider
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| issuer | string | ✓ | Issuer as set in callback response of identity provider |
| metadata | base64 | ✗ | Metadata of identity provider |
| name | string | ✗ | Chosen name for this auth provider |
| settings | object | ✗ | |
| └ attributeMapping | object | ✗ | Mapping of user attributes to AC fields |
| └ entityId | string | ✗ | Optional entity identifier, e.g. Microsoft Entra Identifier (Azure) |
| └ configuration | object | ✗ | Old configuration with metadata properties and attribute mapping |
| └ legacy | boolean | ✗ | DO NOT USE |
| type | string | ✗ | Type of auth, e.g. adfs, azure or generic SAML |
Response
| Field | Type | Description |
|---|---|---|
| deleted | boolean | If true, the authProvider is finally destroyed. |
| flag | integer | Flag of this auth provider (1 = in trash) |
| id | integer | Internal ID |
| issuer | string | Issuer as set in callback response of identity provider |
| lastEditorId | integer | Id of the last editor |
| lastUsed | integer | Unix timestamp of last usage of this authprovider |
| metadata | string | Metadata of identity provider |
| name | string | Chosen name for this auth provider |
| settings | object | Settings for this authProvider |
| └ attributeMapping | object | Mapping of user attributes to AC fields |
| └ entityId | string | Optional entity identifier, e.g. Microsoft Entra Identifier (Azure) |
| └ configuration | object | Old configuration with metadata properties and attribute mapping |
| └ legacy | boolean | DO NOT USE |
| ssoIdentifier | string | Identifier as used in app configuraion |
| type | string | Type of auth, e.g. adfs, azure or generic SAML |
Update AuthProvider
With this endpoint, you can modify the properties of an existing auth provider. This is useful when your identity provider’s configuration changes or when you need to adjust attribute mappings.
PUT/v4/authprovider
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| flag | integer | ✗ | Flag of this auth provider (1 = in trash) |
| id | integer | ✓ | Internal ID |
| issuer | string | ✗ | Issuer as set in callback response of identity provider |
| metadata | base64 | ✗ | Metadata of identity provider |
| name | string | ✓ | Chosen name for this auth provider |
| settings | object | ✗ | |
| └ attributeMapping | object | ✗ | Mapping of user attributes to AC fields |
| └ entityId | string | ✗ | Optional entity identifier, e.g. Microsoft Entra Identifier (Azure) |
| └ configuration | object | ✗ | Old configuration with metadata properties and attribute mapping |
| └ legacy | boolean | ✗ | DO NOT USE |
| type | string | ✓ | Type of auth, e.g. adfs, azure or generic SAML |
Response
| Field | Type | Description |
|---|---|---|
| deleted | boolean | If true, the authProvider is finally destroyed. |
| flag | integer | Flag of this auth provider (1 = in trash) |
| id | integer | Internal ID |
| issuer | string | Issuer as set in callback response of identity provider |
| lastEditorId | integer | Id of the last editor |
| lastUsed | integer | Unix timestamp of last usage of this authprovider |
| metadata | string | Metadata of identity provider |
| name | string | Chosen name for this auth provider |
| settings | object | Settings for this authProvider |
| └ attributeMapping | object | Mapping of user attributes to AC fields |
| └ entityId | string | Optional entity identifier, e.g. Microsoft Entra Identifier (Azure) |
| └ configuration | object | Old configuration with metadata properties and attribute mapping |
| └ legacy | boolean | DO NOT USE |
| ssoIdentifier | string | Identifier as used in app configuraion |
| type | string | Type of auth, e.g. adfs, azure or generic SAML |
Destroy AuthProvider
Use this endpoint to remove an auth provider. By default, the provider is moved to the trash (flag=1), but can be permanently deleted with the forceDestroy=true parameter.
DELETE/v4/authprovider
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| forceDestroy | boolean | ✗ | If true, the authProvider is finally destroyed. |
| id | integer | ✓ | Internal ID |
Response
| Field | Type | Description |
|---|---|---|
| deleted | boolean | If true, the authProvider is finally destroyed. |
| flag | integer | Flag of this auth provider (1 = in trash) |
| id | integer | Internal ID |
| issuer | string | Issuer as set in callback response of identity provider |
| lastEditorId | integer | Id of the last editor |
| lastUsed | integer | Unix timestamp of last usage of this authprovider |
| metadata | string | Metadata of identity provider |
| name | string | Chosen name for this auth provider |
| settings | object | Settings for this authProvider |
| └ attributeMapping | object | Mapping of user attributes to AC fields |
| └ entityId | string | Optional entity identifier, e.g. Microsoft Entra Identifier (Azure) |
| └ configuration | object | Old configuration with metadata properties and attribute mapping |
| └ legacy | boolean | DO NOT USE |
| ssoIdentifier | string | Identifier as used in app configuraion |
| type | string | Type of auth, e.g. adfs, azure or generic SAML |