Jump to

• Request
• Response

List OIDC Provider Configurations

get

/api/v1/configuration/oidcProviderConfig

List OIDC provider configurations. Client secrets are returned masked.

Request

Header Parameters

• Authorization(required): string
  Bearer access token. Supply as: Bearer .

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object OidcProviderConfig
  OIDC provider configuration.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/OidcProviderConfig"
    }
}

Nested Schema : OidcProviderConfig

Type: object

OIDC provider configuration.

Show Source

• active: boolean
  Read Only: true
• bpmAdminGroup(required): string
• daApproverGroup(required): string
• daDeployerGroup(required): string
• daSuperAdminGroup(required): string
• daTokenAdminGroup(required): string
• fabricCaAdminGroup(required): string
• instanceAdminGroup(required): string
• instanceApiClientGroup(required): string
• instanceOperatorGroup(required): string
• providerAuthEndpoint: string
  Read Only: true

  Populated from providerWellKnownConfigUri.
• providerClientClaimName(required): string
• providerClientClaimValue(required): string
• providerClientId(required): string
• providerClientSecret: string(password)
  Required on create and optional on update. Returned masked.
• providerEndSessionEndpoint: string
  Read Only: true

  Populated from providerWellKnownConfigUri when advertised by the provider.
• providerGroupsClaimName(required): string
• providerId: string
  Read Only: true
• providerissuerUrl: string
  Read Only: true

  Populated from providerWellKnownConfigUri.
• providerjwksUri: string
  Read Only: true

  Populated from providerWellKnownConfigUri.
• providerName(required): string
• providerScope(required): string
• providerTokenEndpoint: string
  Read Only: true

  Populated from providerWellKnownConfigUri.
• providerType(required): string
• providerUserClaimName(required): string
• providerWellKnownConfigUri(required): string
  Required OIDC discovery document URI.
• walletOrgAdminGroup(required): string
• walletOrgUserGroup(required): string
• walletSuperAdminGroup(required): string

{
    "description":"OIDC provider configuration.",
    "type":"object",
    "required":[
        "providerName",
        "providerType",
        "providerWellKnownConfigUri",
        "providerScope",
        "providerClientClaimName",
        "providerClientClaimValue",
        "providerGroupsClaimName",
        "providerClientId",
        "providerUserClaimName",
        "bpmAdminGroup",
        "instanceAdminGroup",
        "instanceOperatorGroup",
        "instanceApiClientGroup",
        "fabricCaAdminGroup",
        "walletSuperAdminGroup",
        "walletOrgAdminGroup",
        "walletOrgUserGroup",
        "daSuperAdminGroup",
        "daTokenAdminGroup",
        "daDeployerGroup",
        "daApproverGroup"
    ],
    "properties":{
        "providerId":{
            "type":"string",
            "readOnly":true
        },
        "providerName":{
            "type":"string"
        },
        "providerType":{
            "type":"string"
        },
        "providerissuerUrl":{
            "type":"string",
            "readOnly":true,
            "description":"Populated from providerWellKnownConfigUri."
        },
        "providerjwksUri":{
            "type":"string",
            "readOnly":true,
            "description":"Populated from providerWellKnownConfigUri."
        },
        "providerAuthEndpoint":{
            "type":"string",
            "readOnly":true,
            "description":"Populated from providerWellKnownConfigUri."
        },
        "providerTokenEndpoint":{
            "type":"string",
            "readOnly":true,
            "description":"Populated from providerWellKnownConfigUri."
        },
        "providerWellKnownConfigUri":{
            "type":"string",
            "description":"Required OIDC discovery document URI."
        },
        "providerEndSessionEndpoint":{
            "type":"string",
            "readOnly":true,
            "description":"Populated from <code>providerWellKnownConfigUri</code> when advertised by the provider."
        },
        "providerScope":{
            "type":"string"
        },
        "providerClientClaimName":{
            "type":"string"
        },
        "providerClientClaimValue":{
            "type":"string"
        },
        "providerGroupsClaimName":{
            "type":"string"
        },
        "providerClientId":{
            "type":"string"
        },
        "providerClientSecret":{
            "type":"string",
            "format":"password",
            "description":"Required on create and optional on update. Returned masked."
        },
        "providerUserClaimName":{
            "type":"string"
        },
        "bpmAdminGroup":{
            "type":"string"
        },
        "walletSuperAdminGroup":{
            "type":"string"
        },
        "instanceAdminGroup":{
            "type":"string"
        },
        "instanceOperatorGroup":{
            "type":"string"
        },
        "instanceApiClientGroup":{
            "type":"string"
        },
        "fabricCaAdminGroup":{
            "type":"string"
        },
        "walletOrgAdminGroup":{
            "type":"string"
        },
        "walletOrgUserGroup":{
            "type":"string"
        },
        "daSuperAdminGroup":{
            "type":"string"
        },
        "daTokenAdminGroup":{
            "type":"string"
        },
        "daDeployerGroup":{
            "type":"string"
        },
        "daApproverGroup":{
            "type":"string"
        },
        "active":{
            "type":"boolean",
            "readOnly":true
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

403 Response

Forbidden. The authenticated caller lacks a required global role, instance-access-group membership, or a valid CSRF token.

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors: array errors
  list of errors
• message(required): string
  A human-readable error string.
• status(required): string
  A short error status that defines the error, meant for programmatic parsing.
• warnings: array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

Back to Top