OIDC Configuration (Infrastructure)

Endpoints to configure external IDPs.

Get OIDC providers

get

Return a complete list of all configured OIDC providers.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Existing oidc providers.

application/json

OidcProviders

totalnumberRequired

The total number of OIDC providers

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

get/api/configurations/oidcproviders

GET /api/configurations/oidcproviders HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "providers": [
    {
      "assignedGroups": [
        {
          "facilityRefs": [
            "text"
          ],
          "group": "text"
        }
      ],
      "clientId": "text",
      "customParameters": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "issuer": "text",
      "name": "text",
      "roleManagementMode": "IDP_MANAGED",
      "status": "ACTIVE",
      "version": 1
    }
  ],
  "total": 1
}

Create OIDC provider

post

Registers an external OIDC provider so the platform can interact with it for user authentication.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

OidcProviderForCreation

clientIdstringRequired

The client id of the OIDC provider

clientSecretstringRequired

The client secret of the OIDC provider

issuerstringRequired

The issuer of the OIDC provider

namestringRequired

The name of the OIDC provider

roleManagementModestring · enumOptional

Determines whether role assignments of this OIDC provider are managed by the IDP (IDP_MANAGED, default) or locally in fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always stays IDP-managed.

Possible values:

statusstring · enumRequired

The status of the OIDC provider

Possible values:

Responses

200

Provider was found.

application/json

StrippedOidcProvider

clientIdstringRequired

The client id of the OIDC provider

idstringRequired

The id of the OIDC provider

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

issuerstringRequired

The issuer of the OIDC provider

namestringRequired

The name of the OIDC provider

roleManagementModestring · enumOptional

Determines whether role assignments of this OIDC provider are managed by the IDP (IDP_MANAGED, default) or locally in fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always stays IDP-managed.

Possible values:

statusstring · enumRequired

The status of the OIDC provider

Possible values:

versionnumberRequired

The version of the OIDC provider

Example: 1

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

The requested entity was not found

application/json

post/api/configurations/oidcproviders

POST /api/configurations/oidcproviders HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "assignedGroups": [
    {
      "facilityRefs": [
        "text"
      ],
      "group": "text"
    }
  ],
  "clientId": "text",
  "clientSecret": "text",
  "customParameters": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "issuer": "text",
  "name": "text",
  "roleManagementMode": "IDP_MANAGED",
  "status": "ACTIVE"
}

{
  "assignedGroups": [
    {
      "facilityRefs": [
        "text"
      ],
      "group": "text"
    }
  ],
  "clientId": "text",
  "customParameters": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "issuer": "text",
  "name": "text",
  "roleManagementMode": "IDP_MANAGED",
  "status": "ACTIVE",
  "version": 1
}

Get OIDC provider

get

Get the configuration of a configured OIDC provider.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

oidcProviderIdstringRequired

Responses

201

The users was successfully created.

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

The requested entity was not found

application/json

get/api/configurations/oidcproviders/{oidcProviderId}

GET /api/configurations/oidcproviders/{oidcProviderId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update OIDC provider

put

Change the configuration of an already configured OIDC provider. The configuration has to contain all necessary values.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

oidcProviderIdstringRequired

Body

OidcProviderForUpdate

clientIdstringRequired

The client id of the OIDC provider

clientSecretstringRequired

The client secret of the OIDC provider

issuerstringRequired

The issuer of the OIDC provider

namestringRequired

The name of the OIDC provider

roleManagementModestring · enumOptional

Determines whether role assignments of this OIDC provider are managed by the IDP (IDP_MANAGED, default) or locally in fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always stays IDP-managed.

Possible values:

statusstring · enumRequired

The status of the OIDC provider

Possible values:

versionnumberRequired

The version of the OIDC provider

Example: 1

Responses

200

Provider was updated successfully

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

The requested entity was not found

application/json

put/api/configurations/oidcproviders/{oidcProviderId}

PUT /api/configurations/oidcproviders/{oidcProviderId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "assignedGroups": [
    {
      "facilityRefs": [
        "text"
      ],
      "group": "text"
    }
  ],
  "clientId": "text",
  "clientSecret": "text",
  "customParameters": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "issuer": "text",
  "name": "text",
  "roleManagementMode": "IDP_MANAGED",
  "status": "ACTIVE",
  "version": 1
}

No content

Delete OIDC provider

delete

Removes an OIDC provider configuration, disabling the platform’s ability to authenticate via that provider.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

oidcProviderIdstringRequired

Responses

200

OIDC Provider was found & you were allowed to delete it.

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

The requested entity was not found

application/json

delete/api/configurations/oidcproviders/{oidcProviderId}

DELETE /api/configurations/oidcproviders/{oidcProviderId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update OIDC provider

patch

Change the configuration of an already configured OIDC provider. Only the specified values are changed.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

oidcProviderIdstringRequired

Body

OidcProviderForPatch

clientIdstringOptional

The client id of the OIDC provider

clientSecretstringOptional

The client secret of the OIDC provider

issuerstringOptional

The issuer of the OIDC provider

namestringOptional

The name of the OIDC provider

roleManagementModestring · enumOptional

Determines whether role assignments of this OIDC provider are managed by the IDP (IDP_MANAGED, default) or locally in fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always stays IDP-managed.

Possible values:

statusstring · enumOptional

The status of the OIDC provider

Possible values:

versionnumberRequired

The version of the OIDC provider

Example: 1

Responses

200

Provider was patched successfully

application/json

StrippedOidcProvider

clientIdstringRequired

The client id of the OIDC provider

idstringRequired

The id of the OIDC provider

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

issuerstringRequired

The issuer of the OIDC provider

namestringRequired

The name of the OIDC provider

roleManagementModestring · enumOptional

Determines whether role assignments of this OIDC provider are managed by the IDP (IDP_MANAGED, default) or locally in fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always stays IDP-managed.

Possible values:

statusstring · enumRequired

The status of the OIDC provider

Possible values:

versionnumberRequired

The version of the OIDC provider

Example: 1

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

The requested entity was not found

application/json

patch/api/configurations/oidcproviders/{oidcProviderId}

PATCH /api/configurations/oidcproviders/{oidcProviderId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "assignedGroups": [
    {
      "facilityRefs": [
        "text"
      ],
      "group": "text"
    }
  ],
  "clientId": "text",
  "clientSecret": "text",
  "customParameters": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "issuer": "text",
  "name": "text",
  "roleManagementMode": "IDP_MANAGED",
  "status": "ACTIVE",
  "version": 1
}

{
  "assignedGroups": [
    {
      "facilityRefs": [
        "text"
      ],
      "group": "text"
    }
  ],
  "clientId": "text",
  "customParameters": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "issuer": "text",
  "name": "text",
  "roleManagementMode": "IDP_MANAGED",
  "status": "ACTIVE",
  "version": 1
}