# README

Go API client for configurationapi

The PingFederate Administrative API is a REST-based interface that provides a programmatic way to make configuration changes to PingFederate as an alternative to using the administrative console.

Expand the resources below to display implementation details on that resource such as the available endpoints, the parameter and response models for the operation, and the model structure of the resources themselves. Each resource operation comes with the ability to interact with the API. You are prompted for proper administration credentials when you try to perform an API operation.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import configurationapi "github.com/pingidentity/pingfederate-go-client"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), configurationapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), configurationapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), configurationapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), configurationapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://localhost/pf-admin-api/v1

ClassMethodHTTP requestDescription
AdministrativeAccountsAPIAddAccountPost /administrativeAccountsAdd a new PingFederate native Administrative Account.
AdministrativeAccountsAPIChangePasswordPost /administrativeAccounts/changePasswordChange the Password of current PingFederate native Account.
AdministrativeAccountsAPIDeleteAccountDelete /administrativeAccounts/{username}Delete a PingFederate native Administrative Account information.
AdministrativeAccountsAPIGetAccountGet /administrativeAccounts/{username}Get a PingFederate native Administrative Account.
AdministrativeAccountsAPIGetAccountsGet /administrativeAccountsGet all the PingFederate native Administrative Accounts.
AdministrativeAccountsAPIResetPasswordPost /administrativeAccounts/{username}/resetPasswordReset the Password of an existing PingFederate native Administrative Account.
AdministrativeAccountsAPIUpdateAccountPut /administrativeAccounts/{username}Update the information for a native Administrative Account.
AuthenticationApiAPICreateApplicationPost /authenticationApi/applicationsCreate a new Authentication API Application.
AuthenticationApiAPIDeleteApplicationDelete /authenticationApi/applications/{id}Delete an Authentication API Application.
AuthenticationApiAPIGetApplicationGet /authenticationApi/applications/{id}Find Authentication API Application by ID.
AuthenticationApiAPIGetAuthenticationApiApplicationsGet /authenticationApi/applicationsGet the collection of Authentication API Applications.
AuthenticationApiAPIGetAuthenticationApiSettingsGet /authenticationApi/settingsGet the Authentication API settings.
AuthenticationApiAPIUpdateApplicationPut /authenticationApi/applications/{id}Update an Authentication API Application.
AuthenticationApiAPIUpdateAuthenticationApiSettingsPut /authenticationApi/settingsSet the Authentication API settings.
AuthenticationPoliciesAPICreateFragmentPost /authenticationPolicies/fragmentsCreate an authentication policy fragment.
AuthenticationPoliciesAPICreatePolicyPost /authenticationPolicies/policyCreate a new authentication policy.
AuthenticationPoliciesAPIDeleteFragmentDelete /authenticationPolicies/fragments/{id}Delete an authentication policy fragment.
AuthenticationPoliciesAPIDeletePolicyDelete /authenticationPolicies/policy/{id}Delete an authentication policy.
AuthenticationPoliciesAPIGetAuthenticationPolicySettingsGet /authenticationPolicies/settingsGet the authentication policies settings.
AuthenticationPoliciesAPIGetDefaultAuthenticationPolicyGet /authenticationPolicies/defaultGet the default configured authentication policy.
AuthenticationPoliciesAPIGetFragmentGet /authenticationPolicies/fragments/{id}Get an authentication policy fragment by ID.
AuthenticationPoliciesAPIGetFragmentsGet /authenticationPolicies/fragmentsGet all of the authentication policies fragments.
AuthenticationPoliciesAPIGetPolicyGet /authenticationPolicies/policy/{id}Get an authentication policy by ID.
AuthenticationPoliciesAPIMovePolicyPost /authenticationPolicies/policy/{id}/moveMove an authentication policy to a location within the policy tree.
AuthenticationPoliciesAPIUpdateAuthenticationPolicySettingsPut /authenticationPolicies/settingsSet the authentication policies settings.
AuthenticationPoliciesAPIUpdateDefaultAuthenticationPolicyPut /authenticationPolicies/defaultSet the default authentication policy.
AuthenticationPoliciesAPIUpdateFragmentPut /authenticationPolicies/fragments/{id}Update an authentication policy fragment.
AuthenticationPoliciesAPIUpdatePolicyPut /authenticationPolicies/policy/{id}Update an authentication policy.
AuthenticationPolicyContractsAPICreateAuthenticationPolicyContractPost /authenticationPolicyContractsCreate a new Authentication Policy Contract.
AuthenticationPolicyContractsAPIDeleteAuthenticationPolicyContractDelete /authenticationPolicyContracts/{id}Delete an Authentication Policy Contract.
AuthenticationPolicyContractsAPIGetAuthenticationPolicyContractGet /authenticationPolicyContracts/{id}Gets the Authentication Policy Contract by ID.
AuthenticationPolicyContractsAPIGetAuthenticationPolicyContractsGet /authenticationPolicyContractsGets the Authentication Policy Contracts.
AuthenticationPolicyContractsAPIUpdateAuthenticationPolicyContractPut /authenticationPolicyContracts/{id}Update an Authentication Policy Contract by ID.
AuthenticationSelectorsAPICreateAuthenticationSelectorPost /authenticationSelectorsCreate a new authentication selector instance.
AuthenticationSelectorsAPIDeleteAuthenticationSelectorDelete /authenticationSelectors/{id}Delete an Authentication Selector instance.
AuthenticationSelectorsAPIGetAuthenticationSelectorGet /authenticationSelectors/{id}Get an Authentication Selector instance by ID.
AuthenticationSelectorsAPIGetAuthenticationSelectorDescriptorsGet /authenticationSelectors/descriptorsGet the list of available Authentication Selector descriptors.
AuthenticationSelectorsAPIGetAuthenticationSelectorDescriptorsByIdGet /authenticationSelectors/descriptors/{id}Get the description of an Authentication Selector plugin by ID.
AuthenticationSelectorsAPIGetAuthenticationSelectorsGet /authenticationSelectorsGet the list of configured Authentication Selector instances.
AuthenticationSelectorsAPIUpdateAuthenticationSelectorPut /authenticationSelectors/{id}Update an authentication selector instance.
BulkAPIExportConfigurationGet /bulk/exportExport all API resources to a JSON file.
BulkAPIImportConfigurationPost /bulk/importImport configuration for a PingFederate deployment from a JSON file.
CaptchaProvidersAPICreateCaptchaProviderPost /captchaProvidersCreate a CAPTCHA provider plugin instance.
CaptchaProvidersAPIDeleteCaptchaProviderDelete /captchaProviders/{id}Delete a CAPTCHA provider plugin instance.
CaptchaProvidersAPIGetCaptchaProviderGet /captchaProviders/{id}Get a specific CAPTCHA provider plugin instance.
CaptchaProvidersAPIGetCaptchaProviderPluginDescriptorGet /captchaProviders/descriptors/{id}Get a CAPTCHA provider plugin descriptor.
CaptchaProvidersAPIGetCaptchaProviderPluginDescriptorsGet /captchaProviders/descriptorsGet a list of available CAPTCHA provider plugin descriptors.
CaptchaProvidersAPIGetCaptchaProvidersGet /captchaProvidersGet a list of CAPTCHA provider plugin instances.
CaptchaProvidersAPIGetCaptchaProvidersSettingsGet /captchaProviders/settingsGet general CAPTCHA providers settings.
CaptchaProvidersAPIUpdateCaptchaProviderPut /captchaProviders/{id}Update a CAPTCHA provider plugin instance.
CaptchaProvidersAPIUpdateCaptchaProvidersSettingsPut /captchaProviders/settingsUpdate general CAPTCHA providers settings.
CertificatesCaAPIDeleteTrustedCADelete /certificates/ca/{id}Delete a trusted certificate authority.
CertificatesCaAPIExportCaCertificateFileGet /certificates/ca/{id}/fileDownload the certificate from a given trusted certificate authority.
CertificatesCaAPIGetTrustedCAsGet /certificates/caGet list of trusted certificate authorities.
CertificatesCaAPIGetTrustedCertGet /certificates/ca/{id}Retrieve details of a trusted certificate authority.
CertificatesCaAPIImportTrustedCAPost /certificates/ca/importImport a new trusted certificate authority.
CertificatesGroupsAPIDeleteCertificateFromGroupDelete /certificates/groups/{groupName}/{id}Delete a certificate from a group.
CertificatesGroupsAPIGetCertificateFromGroupGet /certificates/groups/{groupName}/{id}Retrieve details of a certificate.
CertificatesGroupsAPIGetCertificatesForGroupGet /certificates/groups/{groupName}Get list of all certificates for a group.
CertificatesGroupsAPIImportFeatureCertPost /certificates/groups/{groupName}/importImport a new certificate to a group.
CertificatesRevocationAPIDeleteOcspCertificateByIdDelete /certificates/revocation/ocspCertificates/{id}Delete an OCSP responder signature verification certificate by ID.
CertificatesRevocationAPIGetOcspCertificateByIdGet /certificates/revocation/ocspCertificates/{id}Get an OCSP responder signature verification certificate by ID.
CertificatesRevocationAPIGetOcspCertificatesGet /certificates/revocation/ocspCertificatesGet the list of available OCSP responder signature verification certificates.
CertificatesRevocationAPIGetRevocationSettingsGet /certificates/revocation/settingsGet certificate revocation settings.
CertificatesRevocationAPIImportOcspCertificatePost /certificates/revocation/ocspCertificatesImport an OCSP responder signature verification certificate.
CertificatesRevocationAPIUpdateRevocationSettingsPut /certificates/revocation/settingsUpdate certificate revocation settings.
ClusterAPIGetClusterStatusGet /cluster/statusGet information on the current status of the cluster.
ClusterAPIStartReplicationPost /cluster/replicateReplicate configuration updates to all nodes in the cluster.
ConfigArchiveAPIExportConfigArchiveGet /configArchive/exportExport a configuration archive.
ConfigArchiveAPIImportConfigArchivePost /configArchive/importImport a configuration archive.
ConfigStoreAPIDeleteConfigStoreSettingDelete /configStore/{bundle}/{id}Delete a setting.
ConfigStoreAPIGetConfigStoreSettingGet /configStore/{bundle}/{id}Get a single setting from a bundle.
ConfigStoreAPIGetConfigStoreSettingsGet /configStore/{bundle}Get all settings from a bundle.
ConfigStoreAPIUpdateConfigStoreSettingPut /configStore/{bundle}/{id}Create or update a setting/bundle.
ConfigurationEncryptionKeysAPIGetConfigurationEncryptionKeysGet /configurationEncryptionKeysGet the list of Configuration Encryption Keys.
ConfigurationEncryptionKeysAPIRotateConfigurationEncryptionKeyPost /configurationEncryptionKeys/rotateRotate the current Configuration Encryption Key.
ConnectionMetadataAPIConvertPost /connectionMetadata/convertConvert a partner's SAML metadata into a JSON representation.
ConnectionMetadataAPIExportPost /connectionMetadata/exportExport a connection's SAML metadata that can be given to a partner.
DataStoresAPICreateDataStorePost /dataStoresCreate a new data store.
DataStoresAPIDeleteDataStoreDelete /dataStores/{id}Delete a data store.
DataStoresAPIGetCustomDataStoreDescriptorGet /dataStores/descriptors/{id}Get the description of a custom data store plugin by ID.
DataStoresAPIGetCustomDataStoreDescriptorsGet /dataStores/descriptorsGet the list of available custom data store descriptors.
DataStoresAPIGetDataStoreGet /dataStores/{id}Find data store by ID.
DataStoresAPIGetDataStoresGet /dataStoresGet list of all data stores.
DataStoresAPIGetDataStoresActionByIdGet /dataStores/{id}/actions/{actionId}Find a data store instance's action by ID.
DataStoresAPIGetDataStoresActionsGet /dataStores/{id}/actionsList the actions for a data store instance.
DataStoresAPIInvokeActionWithOptionsPost /dataStores/{id}/actions/{actionId}/invokeActionInvokes an action for a data source instance.
DataStoresAPIUpdateDataStorePut /dataStores/{id}Update a data store.
ExtendedPropertiesAPIGetExtendedPropertiesGet /extendedPropertiesGet the defined Extended Properties.
ExtendedPropertiesAPIUpdateExtendedPropertiesPut /extendedPropertiesUpdate the Extended Properties.
IdentityStoreProvisionersAPICreateIdentityStoreProvisionerPost /identityStoreProvisionersCreate a new identity store provisioner instance.
IdentityStoreProvisionersAPIDeleteIdentityStoreProvisionerDelete /identityStoreProvisioners/{id}Delete an identity store provisioner instance
IdentityStoreProvisionersAPIGetIdentityStoreProvisionerGet /identityStoreProvisioners/{id}Get an identity store provisioner by ID.
IdentityStoreProvisionersAPIGetIdentityStoreProvisionerDescriptorByIdGet /identityStoreProvisioners/descriptors/{id}Get the descriptor of an identity store provisioner by ID.
IdentityStoreProvisionersAPIGetIdentityStoreProvisionerDescriptorsGet /identityStoreProvisioners/descriptorsGet the list of available identity store provisioner descriptors.
IdentityStoreProvisionersAPIGetIdentityStoreProvisionersGet /identityStoreProvisionersGet the list of configured identity store provisioner instances.
IdentityStoreProvisionersAPIUpdateIdentityStoreProvisionerPut /identityStoreProvisioners/{id}Update an identity store provisioner instance
IdpAdaptersAPICreateIdpAdapterPost /idp/adaptersCreate a new IdP adapter instance.
IdpAdaptersAPIDeleteIdpAdapterDelete /idp/adapters/{id}Delete an IdP adapter instance.
IdpAdaptersAPIGetIdpAdapterGet /idp/adapters/{id}Find an IdP adapter instance by ID.
IdpAdaptersAPIGetIdpAdapterDescriptorsGet /idp/adapters/descriptorsGet the list of available IdP adapter descriptors.
IdpAdaptersAPIGetIdpAdapterDescriptorsByIdGet /idp/adapters/descriptors/{id}Get the description of an IdP adapter plugin by ID.
IdpAdaptersAPIGetIdpAdaptersGet /idp/adaptersGet the list of configured IdP adapter instances.
IdpAdaptersAPIGetIdpAdaptersActionByIdGet /idp/adapters/{id}/actions/{actionId}Find an IdP adapter instance's action by ID.
IdpAdaptersAPIGetIdpAdaptersActionsGet /idp/adapters/{id}/actionsList the actions for an IdP adapter instance.
IdpAdaptersAPIInvokeIdpAdaptersActionWithOptionsPost /idp/adapters/{id}/actions/{actionId}/invokeActionInvokes an action for an IdP adapter instance.
IdpAdaptersAPIUpdateIdpAdapterPut /idp/adapters/{id}Update an IdP adapter instance.
IdpConnectorsAPIGetIdpConnectorDescriptorByIdGet /idp/connectors/descriptors/{id}Get the list of available connector descriptors.
IdpConnectorsAPIGetIdpConnectorDescriptorsGet /idp/connectors/descriptorsGet the list of available IdP connector descriptors.
IdpDefaultUrlsAPIGetDefaultUrlGet /idp/defaultUrlsGets the IDP Default URL settings.
IdpDefaultUrlsAPIUpdateDefaultUrlSettingsPut /idp/defaultUrlsUpdate the IDP Default URL settings.
IdpSpConnectionsAPIAddSpConnectionCertPost /idp/spConnections/{id}/credentials/certsAdd a new SP connection certificate.
IdpSpConnectionsAPICreateSpConnectionPost /idp/spConnectionsCreate a new SP connection.
IdpSpConnectionsAPIDeleteSpConnectionDelete /idp/spConnections/{id}Delete an SP connection.
IdpSpConnectionsAPIGetDecryptionKeysGet /idp/spConnections/{id}/credentials/decryptionKeysGet the decryption keys of an SP connection.
IdpSpConnectionsAPIGetSpConnectionGet /idp/spConnections/{id}Find SP connection by ID.
IdpSpConnectionsAPIGetSpConnectionCertsGet /idp/spConnections/{id}/credentials/certsGet the SP connection's certificates.
IdpSpConnectionsAPIGetSpConnectionsGet /idp/spConnectionsGet list of SP connections.
IdpSpConnectionsAPIGetSpSigningSettingsGet /idp/spConnections/{id}/credentials/signingSettingsGet the SP connection's signature settings.
IdpSpConnectionsAPIUpdateDecryptionKeysPut /idp/spConnections/{id}/credentials/decryptionKeysUpdating the SP connection's decryption keys.
IdpSpConnectionsAPIUpdateSpConnectionPut /idp/spConnections/{id}Update an SP connection.
IdpSpConnectionsAPIUpdateSpConnectionCertsPut /idp/spConnections/{id}/credentials/certsUpdate the SP connection's certificates.
IdpSpConnectionsAPIUpdateSpSigningSettingsPut /idp/spConnections/{id}/credentials/signingSettingsUpdate the SP connection's signature settings.
IdpStsRequestParametersContractsAPICreateStsRequestParamContractPost /idp/stsRequestParametersContractsCreate a new STS Request Parameters Contract.
IdpStsRequestParametersContractsAPIDeleteStsRequestParamContractByIdDelete /idp/stsRequestParametersContracts/{id}Delete a STS Request Parameters Contract.
IdpStsRequestParametersContractsAPIGetStsRequestParamContractByIdGet /idp/stsRequestParametersContracts/{id}Get a STS Request Parameters Contract.
IdpStsRequestParametersContractsAPIGetStsRequestParamContractsGet /idp/stsRequestParametersContractsGet the list of STS Request Parameters Contracts.
IdpStsRequestParametersContractsAPIUpdateStsRequestParamContractByIdPut /idp/stsRequestParametersContracts/{id}Update a STS Request Parameters Contract.
IdpToSpAdapterMappingAPICreateIdpToSpAdapterMappingPost /idpToSpAdapterMappingCreate a new IdP-to-SP Adapter mapping.
IdpToSpAdapterMappingAPIDeleteIdpToSpAdapterMappingsByIdDelete /idpToSpAdapterMapping/{id}Delete an Adapter to Adapter Mapping.
IdpToSpAdapterMappingAPIGetIdpToSpAdapterMappingsGet /idpToSpAdapterMappingGet list of IdP-to-SP Adapter Mappings.
IdpToSpAdapterMappingAPIGetIdpToSpAdapterMappingsByIdGet /idpToSpAdapterMapping/{id}Get an IdP-to-SP Adapter Mapping.
IdpToSpAdapterMappingAPIUpdateIdpToSpAdapterMappingPut /idpToSpAdapterMapping/{id}Update the specified IdP-to-SP Adapter mapping.
IdpTokenProcessorsAPICreateTokenProcessorPost /idp/tokenProcessorsCreate a new token processor instance.
IdpTokenProcessorsAPIDeleteTokenProcessorDelete /idp/tokenProcessors/{id}Delete a token processor instance.
IdpTokenProcessorsAPIGetTokenProcessorGet /idp/tokenProcessors/{id}Find a token processor instance by ID.
IdpTokenProcessorsAPIGetTokenProcessorDescriptorsGet /idp/tokenProcessors/descriptorsGet the list of available token processors.
IdpTokenProcessorsAPIGetTokenProcessorDescriptorsByIdGet /idp/tokenProcessors/descriptors/{id}Get the description of a token processor plugin by ID.
IdpTokenProcessorsAPIGetTokenProcessorsGet /idp/tokenProcessorsGet the list of token processor instances.
IdpTokenProcessorsAPIUpdateTokenProcessorPut /idp/tokenProcessors/{id}Update a token processor instance.
IncomingProxySettingsAPIGetIncomingProxySettingsGet /incomingProxySettingsGet incoming proxy settings.
IncomingProxySettingsAPIUpdateIncomingProxySettingsPut /incomingProxySettingsUpdate incoming proxy settings.
KerberosRealmsAPICreateKerberosRealmPost /kerberos/realmsCreate a new Kerberos Realm.
KerberosRealmsAPIDeleteKerberosRealmDelete /kerberos/realms/{id}Delete a Kerberos Realm.
KerberosRealmsAPIGetKerberosRealmGet /kerberos/realms/{id}Find a Kerberos Realm by ID.
KerberosRealmsAPIGetKerberosRealmSettingsGet /kerberos/realms/settingsGets the Kerberos Realms Settings.
KerberosRealmsAPIGetKerberosRealmsGet /kerberos/realmsGets the Kerberos Realms.
KerberosRealmsAPIUpdateKerberosRealmPut /kerberos/realms/{id}Update a Kerberos Realm by ID.
KerberosRealmsAPIUpdateKerberosRealmSettingsPut /kerberos/realms/settingsSet/Update the Kerberos Realms Settings.
KeyPairsAPIGetKeyAlgorithmsGet /keyPairs/keyAlgorithmsGet list of the key algorithms supported for key pair generation.
KeyPairsOauthOpenIdConnectAPICreateKeySetPost /keyPairs/oauthOpenIdConnect/additionalKeySetsCreate a new OAuth/OpenID Connect additional signing key set.
KeyPairsOauthOpenIdConnectAPIDeleteKeySetDelete /keyPairs/oauthOpenIdConnect/additionalKeySets/{id}Delete an existing OAuth/OpenID Connect additional signing key set.
KeyPairsOauthOpenIdConnectAPIGetKeySetGet /keyPairs/oauthOpenIdConnect/additionalKeySets/{id}Retrieve an OAuth/OpenID Connect additional signing key set.
KeyPairsOauthOpenIdConnectAPIGetKeySetsGet /keyPairs/oauthOpenIdConnect/additionalKeySetsRetrieve OAuth/OpenID Connect additional signing key sets.
KeyPairsOauthOpenIdConnectAPIGetOauthOidcKeysSettingsGet /keyPairs/oauthOpenIdConnectRetrieve OAuth/OpenID Connect key settings.
KeyPairsOauthOpenIdConnectAPIUpdateKeySetPut /keyPairs/oauthOpenIdConnect/additionalKeySets/{id}Update an existing OAuth/OpenID Connect additional signing key set.
KeyPairsOauthOpenIdConnectAPIUpdateOAuthOidcKeysSettingsPut /keyPairs/oauthOpenIdConnectUpdate OAuth/OpenID Connect key settings.
KeyPairsSigningAPICreateSigningKeyPairPost /keyPairs/signing/generateGenerate a new key pair.
KeyPairsSigningAPIDeleteKeyPairRotationSettingsDelete /keyPairs/signing/{id}/rotationSettingsDelete rotation settings for a signing key pair.
KeyPairsSigningAPIDeleteSigningKeyPairDelete /keyPairs/signing/{id}Delete a key pair.
KeyPairsSigningAPIExportCertificateFileGet /keyPairs/signing/{id}/certificateDownload the certificate from a given key pair.
KeyPairsSigningAPIExportCsrGet /keyPairs/signing/{id}/csrGenerate a new certificate signing request (CSR) for this key pair.
KeyPairsSigningAPIExportPEMFilePost /keyPairs/signing/{id}/pemDownload the key pair in PEM format.
KeyPairsSigningAPIExportPKCS12FilePost /keyPairs/signing/{id}/pkcs12Download the key pair in PKCS12 format.
KeyPairsSigningAPIGetRotationSettingsGet /keyPairs/signing/{id}/rotationSettingsRetrieve details of rotation settings for a key pair.
KeyPairsSigningAPIGetSigningKeyPairGet /keyPairs/signing/{id}Retrieve details of a key pair.
KeyPairsSigningAPIGetSigningKeyPairsGet /keyPairs/signingGet list of key pairs.
KeyPairsSigningAPIImportCsrResponsePost /keyPairs/signing/{id}/csrImport a CSR response for this key pair.
KeyPairsSigningAPIImportSigningKeyPairPost /keyPairs/signing/importImport a new key pair.
KeyPairsSigningAPIUpdateRotationSettingsPut /keyPairs/signing/{id}/rotationSettingsAdd rotation settings to a key pair
KeyPairsSslClientAPICreateSslClientKeyPairPost /keyPairs/sslClient/generateGenerate a new key pair.
KeyPairsSslClientAPIDeleteSslClientKeyPairDelete /keyPairs/sslClient/{id}Delete a key pair.
KeyPairsSslClientAPIExportSslClientCertificateFileGet /keyPairs/sslClient/{id}/certificateDownload the certificate from a given key pair.
KeyPairsSslClientAPIExportSslClientCsrGet /keyPairs/sslClient/{id}/csrGenerate a new certificate signing request (CSR) for this key pair.
KeyPairsSslClientAPIExportSslClientPEMFilePost /keyPairs/sslClient/{id}/pemDownload the key pair in PEM format.
KeyPairsSslClientAPIExportSslClientPKCS12FilePost /keyPairs/sslClient/{id}/pkcs12Download the key pair in PKCS12 format.
KeyPairsSslClientAPIGetSslClientKeyPairGet /keyPairs/sslClient/{id}Retrieve details of a key pair.
KeyPairsSslClientAPIGetSslClientKeyPairsGet /keyPairs/sslClientGet list of key pairs.
KeyPairsSslClientAPIImportSslClientCsrResponsePost /keyPairs/sslClient/{id}/csrImport a CSR response for this key pair.
KeyPairsSslClientAPIImportSslClientKeyPairPost /keyPairs/sslClient/importImport a new key pair.
KeyPairsSslServerAPICreateSslServerKeyPairPost /keyPairs/sslServer/generateGenerate a new key pair.
KeyPairsSslServerAPIDeleteSslServerKeyPairDelete /keyPairs/sslServer/{id}Delete a key pair.
KeyPairsSslServerAPIExportSslServerCertificateFileGet /keyPairs/sslServer/{id}/certificateDownload the certificate from a given key pair.
KeyPairsSslServerAPIExportSslServerCsrGet /keyPairs/sslServer/{id}/csrGenerate a new certificate signing request (CSR) for this key pair.
KeyPairsSslServerAPIExportSslServerPEMFilePost /keyPairs/sslServer/{id}/pemDownload the key pair in PEM format.
KeyPairsSslServerAPIExportSslServerPKCS12FilePost /keyPairs/sslServer/{id}/pkcs12Download the key pair in PKCS12 format.
KeyPairsSslServerAPIGetSslServerKeyPairGet /keyPairs/sslServer/{id}Retrieve details of a key pair.
KeyPairsSslServerAPIGetSslServerKeyPairsGet /keyPairs/sslServerGet list of key pairs.
KeyPairsSslServerAPIGetSslServerSettingsGet /keyPairs/sslServer/settingsGet the SSL Server Certificate Settings.
KeyPairsSslServerAPIImportSslServerCsrResponsePost /keyPairs/sslServer/{id}/csrImport a CSR response for this key pair.
KeyPairsSslServerAPIImportSslServerKeyPairPost /keyPairs/sslServer/importImport a new key pair.
KeyPairsSslServerAPIUpdateSslServerSettingsPut /keyPairs/sslServer/settingsUpdate the SSL Server Certificate Settings.
LicenseAPIGetLicenseGet /licenseGet a license summary.
LicenseAPIGetLicenseAgreementGet /license/agreementGet license agreement link.
LicenseAPIUpdateLicensePut /licenseImport a license.
LicenseAPIUpdateLicenseAgreementPut /license/agreementAccept license agreement.
LocalIdentityIdentityProfilesAPICreateIdentityProfilePost /localIdentity/identityProfilesCreate a new local identity profile.
LocalIdentityIdentityProfilesAPIDeleteIdentityProfileDelete /localIdentity/identityProfiles/{id}Delete the local identity profile by ID.
LocalIdentityIdentityProfilesAPIGetIdentityProfileGet /localIdentity/identityProfiles/{id}Get the local identity profile by ID.
LocalIdentityIdentityProfilesAPIGetIdentityProfilesGet /localIdentity/identityProfilesGet the list of configured local identity profiles.
LocalIdentityIdentityProfilesAPIUpdateIdentityProfilePut /localIdentity/identityProfiles/{id}Update the local identity profile by ID.
MetadataUrlsAPIAddMetadataUrlPost /metadataUrlsAdd a new Metadata URL.
MetadataUrlsAPIDeleteMetadataUrlDelete /metadataUrls/{id}Delete a Metadata URL by ID.
MetadataUrlsAPIGetMetadataUrlGet /metadataUrls/{id}Get a Metadata URL by ID.
MetadataUrlsAPIGetMetadataUrlsGet /metadataUrlsGet a list of Metadata URLs
MetadataUrlsAPIUpdateMetadataUrlPut /metadataUrls/{id}Update a Metadata URL by ID.
NotificationPublishersAPICreateNotificationPublisherPost /notificationPublishersCreate a notification publisher plugin instance.
NotificationPublishersAPIDeleteNotificationPublisherDelete /notificationPublishers/{id}Delete a notification publisher plugin instance.
NotificationPublishersAPIGetNotificationPublisherGet /notificationPublishers/{id}Get a specific notification publisher plugin instance.
NotificationPublishersAPIGetNotificationPublisherActionsGet /notificationPublishers/{id}/actionsList the actions for a notification publisher plugin instance.
NotificationPublishersAPIGetNotificationPublisherPluginDescriptorGet /notificationPublishers/descriptors/{id}Get the description of a notification publisher plugin descriptor.
NotificationPublishersAPIGetNotificationPublisherPluginDescriptorsGet /notificationPublishers/descriptorsGet the list of available Notification Publisher Plugin descriptors.
NotificationPublishersAPIGetNotificationPublishersGet /notificationPublishersGet a list of notification publisher plugin instances.
NotificationPublishersAPIGetNotificationPublishersActionGet /notificationPublishers/{id}/actions/{actionId}Find an notification publisher plugin instance's action by ID.
NotificationPublishersAPIGetNotificationPublishersSettingsGet /notificationPublishers/settingsGet general notification publisher settings.
NotificationPublishersAPIInvokeNotificationPublishersActionWithOptionsPost /notificationPublishers/{id}/actions/{actionId}/invokeActionInvokes an action for notification publisher plugin instance.
NotificationPublishersAPIUpdateNotificationPublisherPut /notificationPublishers/{id}Update a notification publisher plugin instance.
NotificationPublishersAPIUpdateNotificationPublishersSettingsPut /notificationPublishers/settingsUpdate general notification publisher settings.
OauthAccessTokenManagersAPICreateTokenManagerPost /oauth/accessTokenManagersCreate a token management plugin instance.
OauthAccessTokenManagersAPIDeleteTokenManagerDelete /oauth/accessTokenManagers/{id}Delete a token management plugin instance.
OauthAccessTokenManagersAPIGetOauthAccessTokenManagersSettingsGet /oauth/accessTokenManagers/settingsGet general access token management settings.
OauthAccessTokenManagersAPIGetTokenManagerGet /oauth/accessTokenManagers/{id}Get a specific token management plugin instance.
OauthAccessTokenManagersAPIGetTokenManagerDescriptorGet /oauth/accessTokenManagers/descriptors/{id}Get the description of a token management plugin descriptor.
OauthAccessTokenManagersAPIGetTokenManagerDescriptorsGet /oauth/accessTokenManagers/descriptorsGet the list of available token management plugin descriptors.
OauthAccessTokenManagersAPIGetTokenManagersGet /oauth/accessTokenManagersGet a list of all token management plugin instances.
OauthAccessTokenManagersAPIUpdateOauthAccessTokenManagersSettingsPut /oauth/accessTokenManagers/settingsUpdate general access token management settings.
OauthAccessTokenManagersAPIUpdateTokenManagerPut /oauth/accessTokenManagers/{id}Update a token management plugin instance.
OauthAccessTokenMappingsAPICreateMappingPost /oauth/accessTokenMappingsCreate a new Access Token Mapping.
OauthAccessTokenMappingsAPIDeleteMappingDelete /oauth/accessTokenMappings/{id}Delete an Access Token Mapping.
OauthAccessTokenMappingsAPIGetMappingGet /oauth/accessTokenMappings/{id}Find the Access Token Mapping by its ID.
OauthAccessTokenMappingsAPIGetMappingsGet /oauth/accessTokenMappingsGet the list of Access Token Mappings.
OauthAccessTokenMappingsAPIUpdateMappingPut /oauth/accessTokenMappings/{id}Update an Access Token Mapping.
OauthAuthServerSettingsAPIAddCommonScopePost /oauth/authServerSettings/scopes/commonScopesAdd a new common scope.
OauthAuthServerSettingsAPIAddCommonScopeGroupPost /oauth/authServerSettings/scopes/commonScopeGroupsCreate a new common scope group.
OauthAuthServerSettingsAPIAddExclusiveScopePost /oauth/authServerSettings/scopes/exclusiveScopesAdd a new exclusive scope.
OauthAuthServerSettingsAPIAddExclusiveScopeGroupPost /oauth/authServerSettings/scopes/exclusiveScopeGroupsCreate a new exclusive scope group.
OauthAuthServerSettingsAPIGetAuthorizationServerSettingsGet /oauth/authServerSettingsGet the Authorization Server Settings.
OauthAuthServerSettingsAPIGetCommonScopeGet /oauth/authServerSettings/scopes/commonScopes/{name}Get an existing common scope.
OauthAuthServerSettingsAPIGetCommonScopeGroupGet /oauth/authServerSettings/scopes/commonScopeGroups/{name}Get an existing common scope group.
OauthAuthServerSettingsAPIGetExclusiveScopeGet /oauth/authServerSettings/scopes/exclusiveScopes/{name}Get an existing exclusive scope.
OauthAuthServerSettingsAPIGetExclusiveScopeGroupGet /oauth/authServerSettings/scopes/exclusiveScopeGroups/{name}Get an existing exclusive scope group.
OauthAuthServerSettingsAPIRemoveCommonScopeDelete /oauth/authServerSettings/scopes/commonScopes/{name}Remove an existing common scope.
OauthAuthServerSettingsAPIRemoveCommonScopeGroupDelete /oauth/authServerSettings/scopes/commonScopeGroups/{name}Remove an existing common scope group.
OauthAuthServerSettingsAPIRemoveExclusiveScopeDelete /oauth/authServerSettings/scopes/exclusiveScopes/{name}Remove an existing exclusive scope.
OauthAuthServerSettingsAPIRemoveExclusiveScopeGroupDelete /oauth/authServerSettings/scopes/exclusiveScopeGroups/{name}Remove an existing exclusive scope group.
OauthAuthServerSettingsAPIUpdateAuthorizationServerSettingsPut /oauth/authServerSettingsUpdate the Authorization Server Settings.
OauthAuthServerSettingsAPIUpdateCommonScopePut /oauth/authServerSettings/scopes/commonScopes/{name}Update an existing common scope.
OauthAuthServerSettingsAPIUpdateCommonScopeGroupPut /oauth/authServerSettings/scopes/commonScopeGroups/{name}Update an existing common scope group.
OauthAuthServerSettingsAPIUpdateExclusiveScopePut /oauth/authServerSettings/scopes/exclusiveScopes/{name}Update an existing exclusive scope.
OauthAuthServerSettingsAPIUpdateExclusiveScopeGroupsPut /oauth/authServerSettings/scopes/exclusiveScopeGroups/{name}Update an existing exclusive scope group.
OauthAuthenticationPolicyContractMappingsAPICreateApcMappingPost /oauth/authenticationPolicyContractMappingsCreate a new authentication policy contract to persistent grant mapping.
OauthAuthenticationPolicyContractMappingsAPIDeleteApcMappingDelete /oauth/authenticationPolicyContractMappings/{id}Delete an authentication policy contract to persistent grant mapping.
OauthAuthenticationPolicyContractMappingsAPIGetApcMappingGet /oauth/authenticationPolicyContractMappings/{id}Find the authentication policy contract to persistent grant mapping by ID.
OauthAuthenticationPolicyContractMappingsAPIGetApcMappingsGet /oauth/authenticationPolicyContractMappingsGet the list of authentication policy contract to persistent grant mappings.
OauthAuthenticationPolicyContractMappingsAPIUpdateApcMappingPut /oauth/authenticationPolicyContractMappings/{id}Update an authentication policy contract to persistent grant mapping.
OauthAuthorizationDetailProcessorsAPICreateAuthorizationDetailProcessorPost /oauth/authorizationDetailProcessorsCreate an authorization detail processor plugin instance.
OauthAuthorizationDetailProcessorsAPIDeleteAuthorizationDetailProcessorDelete /oauth/authorizationDetailProcessors/{id}Delete an authorization detail processor plugin instance.
OauthAuthorizationDetailProcessorsAPIGetAuthorizationDetailProcessorGet /oauth/authorizationDetailProcessors/{id}Get a specific authorization detail processor plugin instance.
OauthAuthorizationDetailProcessorsAPIGetAuthorizationDetailProcessorPluginDescriptorGet /oauth/authorizationDetailProcessors/descriptors/{id}Get an authorization detail processor plugin descriptor.
OauthAuthorizationDetailProcessorsAPIGetAuthorizationDetailProcessorPluginDescriptorsGet /oauth/authorizationDetailProcessors/descriptorsGet a list of available authorization detail processor plugin descriptors.
OauthAuthorizationDetailProcessorsAPIGetAuthorizationDetailProcessorsGet /oauth/authorizationDetailProcessorsGet a list of authorization detail processor plugin instances.
OauthAuthorizationDetailProcessorsAPIUpdateAuthorizationDetailProcessorPut /oauth/authorizationDetailProcessors/{id}Update an authorization detail processor plugin instance.
OauthAuthorizationDetailTypesAPIAddAuthorizationDetailTypePost /oauth/authorizationDetailTypesCreate a new authorization detail type.
OauthAuthorizationDetailTypesAPIDeleteAuthorizationDetailTypeDelete /oauth/authorizationDetailTypes/{id}Delete an authorization detail type.
OauthAuthorizationDetailTypesAPIGetAuthorizationDetailTypeByIdGet /oauth/authorizationDetailTypes/{id}Get an authorization detail type.
OauthAuthorizationDetailTypesAPIGetAuthorizationDetailTypesGet /oauth/authorizationDetailTypesGet the list of authorization detail types.
OauthAuthorizationDetailTypesAPIUpdateAuthorizationDetailTypePut /oauth/authorizationDetailTypes/{id}Update an authorization detail type.
OauthCibaServerPolicyAPICreateCibaServerPolicyPost /oauth/cibaServerPolicy/requestPoliciesCreate a new request policy.
OauthCibaServerPolicyAPIDeleteCibaServerPolicyDelete /oauth/cibaServerPolicy/requestPolicies/{id}Delete a request policy.
OauthCibaServerPolicyAPIGetCibaServerPoliciesGet /oauth/cibaServerPolicy/requestPoliciesGet list of request policies.
OauthCibaServerPolicyAPIGetCibaServerPolicyByIdGet /oauth/cibaServerPolicy/requestPolicies/{id}Find request policy by ID.
OauthCibaServerPolicyAPIGetCibaServerPolicySettingsGet /oauth/cibaServerPolicy/settingsGet general ciba server request policy settings.
OauthCibaServerPolicyAPIUpdateCibaServerPolicyPut /oauth/cibaServerPolicy/requestPolicies/{id}Update a request policy.
OauthCibaServerPolicyAPIUpdateCibaServerPolicySettingsPut /oauth/cibaServerPolicy/settingsUpdate general ciba server request policy settings.
OauthClientRegistrationPoliciesAPICreateDynamicClientRegistrationPolicyPost /oauth/clientRegistrationPoliciesCreate a client registration policy plugin instance.
OauthClientRegistrationPoliciesAPIDeleteDynamicClientRegistrationPolicyDelete /oauth/clientRegistrationPolicies/{id}Delete a client registration policy plugin instance.
OauthClientRegistrationPoliciesAPIGetDynamicClientRegistrationDescriptorGet /oauth/clientRegistrationPolicies/descriptors/{id}Get the description of a client registration policy plugin descriptor.
OauthClientRegistrationPoliciesAPIGetDynamicClientRegistrationDescriptorsGet /oauth/clientRegistrationPolicies/descriptorsGet the list of available client registration policy plugin descriptors.
OauthClientRegistrationPoliciesAPIGetDynamicClientRegistrationPoliciesGet /oauth/clientRegistrationPoliciesGet a list of client registration policy plugin instances.
OauthClientRegistrationPoliciesAPIGetDynamicClientRegistrationPolicyGet /oauth/clientRegistrationPolicies/{id}Get a specific client registration policy plugin instance.
OauthClientRegistrationPoliciesAPIUpdateDynamicClientRegistrationPolicyPut /oauth/clientRegistrationPolicies/{id}Update a client registration policy plugin instance.
OauthClientSettingsAPIGetOauthClientSettingsGet /oauth/clientSettingsConfigure the client settings.
OauthClientSettingsAPIUpdateOauthClientSettingsPut /oauth/clientSettingsUpdate the client settings.
OauthClientsAPICreateOauthClientPost /oauth/clientsCreate a new OAuth client.
OauthClientsAPIDeleteOauthClientDelete /oauth/clients/{id}Delete an OAuth client.
OauthClientsAPIGetOauthClientByIdGet /oauth/clients/{id}Find the OAuth client by ID.
OauthClientsAPIGetOauthClientSecretGet /oauth/clients/{id}/clientAuth/clientSecretGet the client secret of an existing OAuth client.
OauthClientsAPIGetOauthClientsGet /oauth/clientsGet the list of OAuth clients.
OauthClientsAPIUpdateOauthClientPut /oauth/clients/{id}Updates the OAuth client.
OauthClientsAPIUpdateOauthClientSecretPut /oauth/clients/{id}/clientAuth/clientSecretUpdate the client secret of an existing OAuth client.
OauthIdpAdapterMappingsAPICreateIdpAdapterMappingPost /oauth/idpAdapterMappingsCreate a new IdP adapter mapping.
OauthIdpAdapterMappingsAPIDeleteIdpAdapterMappingDelete /oauth/idpAdapterMappings/{id}Delete an IdP adapter mapping.
OauthIdpAdapterMappingsAPIGetIdpAdapterMappingGet /oauth/idpAdapterMappings/{id}Find the IdP adapter mapping by the ID.
OauthIdpAdapterMappingsAPIGetIdpAdapterMappingsGet /oauth/idpAdapterMappingsGet the list of IdP adapter mappings.
OauthIdpAdapterMappingsAPIUpdateIdpAdapterMappingPut /oauth/idpAdapterMappings/{id}Update an IdP adapter mapping.
OauthIssuersAPIAddOauthIssuerPost /oauth/issuersCreate a new virtual issuer.
OauthIssuersAPIDeleteOauthIssuerDelete /oauth/issuers/{id}Delete a virtual issuer.
OauthIssuersAPIGetOauthIssuerByIdGet /oauth/issuers/{id}Find a virtual issuer by ID.
OauthIssuersAPIGetOauthIssuersGet /oauth/issuersGet the list of virtual issuers.
OauthIssuersAPIUpdateOauthIssuerPut /oauth/issuers/{id}Update a virtual issuer.
OauthOpenIdConnectAPICreateOIDCPolicyPost /oauth/openIdConnect/policiesCreate a new OpenID Connect Policy.
OauthOpenIdConnectAPIDeleteOIDCPolicyDelete /oauth/openIdConnect/policies/{id}Delete an OpenID Connect Policy.
OauthOpenIdConnectAPIGetOIDCPoliciesGet /oauth/openIdConnect/policiesGet list of OpenID Connect Policies.
OauthOpenIdConnectAPIGetOIDCPolicyGet /oauth/openIdConnect/policies/{id}Find OpenID Connect Policy by ID.
OauthOpenIdConnectAPIGetOIDCSettingsGet /oauth/openIdConnect/settingsGet the OpenID Connect Settings.
OauthOpenIdConnectAPIUpdateOIDCPolicyPut /oauth/openIdConnect/policies/{id}Update an OpenID Connect Policy.
OauthOpenIdConnectAPIUpdateOIDCSettingsPut /oauth/openIdConnect/settingsSet the OpenID Connect Settings.
OauthOutOfBandAuthPluginsAPICreateOOBAuthenticatorPost /oauth/outOfBandAuthPluginsCreate an Out of Band authenticator plugin instance.
OauthOutOfBandAuthPluginsAPIDeleteOOBAuthenticatorDelete /oauth/outOfBandAuthPlugins/{id}Delete an Out of Band authenticator plugin instance.
OauthOutOfBandAuthPluginsAPIGetOOBActionGet /oauth/outOfBandAuthPlugins/{id}/actions/{actionId}Find an Out of Band authenticator plugin instance's action by ID.
OauthOutOfBandAuthPluginsAPIGetOOBActionsGet /oauth/outOfBandAuthPlugins/{id}/actionsList of actions for an Out of Band authenticator plugin instance.
OauthOutOfBandAuthPluginsAPIGetOOBAuthPluginDescriptorGet /oauth/outOfBandAuthPlugins/descriptors/{id}Get the descriptor of an Out of Band authenticator plugin.
OauthOutOfBandAuthPluginsAPIGetOOBAuthPluginDescriptorsGet /oauth/outOfBandAuthPlugins/descriptorsGet the list of available Out of Band authenticator plugin descriptors.
OauthOutOfBandAuthPluginsAPIGetOOBAuthenticatorGet /oauth/outOfBandAuthPlugins/{id}Get a specific Out of Band authenticator plugin instance.
OauthOutOfBandAuthPluginsAPIGetOOBAuthenticatorsGet /oauth/outOfBandAuthPluginsGet a list of Out of Band authenticator plugin instances.
OauthOutOfBandAuthPluginsAPIInvokeOOBActionWithOptionsPost /oauth/outOfBandAuthPlugins/{id}/actions/{actionId}/invokeActionInvokes an action for Out of Band authenticator plugin instance.
OauthOutOfBandAuthPluginsAPIUpdateOOBAuthenticatorPut /oauth/outOfBandAuthPlugins/{id}Update an Out of Band authenticator plugin instance.
OauthResourceOwnerCredentialsMappingsAPICreateResourceOwnerCredentialsMappingPost /oauth/resourceOwnerCredentialsMappingsCreate a new Resource Owner Credentials mapping.
OauthResourceOwnerCredentialsMappingsAPIDeleteResourceOwnerCredentialsMappingDelete /oauth/resourceOwnerCredentialsMappings/{id}Delete a Resource Owner Credentials mapping.
OauthResourceOwnerCredentialsMappingsAPIGetResourceOwnerCredentialsMappingGet /oauth/resourceOwnerCredentialsMappings/{id}Find the Resource Owner Credentials mapping by the ID.
OauthResourceOwnerCredentialsMappingsAPIGetResourceOwnerCredentialsMappingsGet /oauth/resourceOwnerCredentialsMappingsGet the list of Resource Owner Credentials Grant Mapping.
OauthResourceOwnerCredentialsMappingsAPIUpdateResourceOwnerCredentialsMappingPut /oauth/resourceOwnerCredentialsMappings/{id}Update a Resource Owner Credentials mapping.
OauthTokenExchangeGeneratorAPICreateGroupPost /oauth/tokenExchange/generator/groupsCreate a new OAuth 2.0 Token Exchange Generator group.
OauthTokenExchangeGeneratorAPIDeleteOauthTokenExchangeGroupDelete /oauth/tokenExchange/generator/groups/{id}Delete an OAuth 2.0 Token Exchange Generator group.
OauthTokenExchangeGeneratorAPIGetOauthTokenExchangeGroupByIdGet /oauth/tokenExchange/generator/groups/{id}Find an OAuth 2.0 Token Exchange Generator group by ID.
OauthTokenExchangeGeneratorAPIGetOauthTokenExchangeGroupsGet /oauth/tokenExchange/generator/groupsGet list of OAuth 2.0 Token Exchange Generator groups.
OauthTokenExchangeGeneratorAPIGetOauthTokenExchangeSettingsGet /oauth/tokenExchange/generator/settingsGet general OAuth 2.0 Token Exchange Generator settings.
OauthTokenExchangeGeneratorAPIUpdateOauthTokenExchangeGroupPut /oauth/tokenExchange/generator/groups/{id}Update an OAuth 2.0 Token Exchange Generator group.
OauthTokenExchangeGeneratorAPIUpdateOauthTokenExchangeSettingsPut /oauth/tokenExchange/generator/settingsUpdate general OAuth 2.0 Token Exchange Generator settings.
OauthTokenExchangeProcessorAPICreateOauthTokenExchangeProcessorPolicyPost /oauth/tokenExchange/processor/policiesCreate a new OAuth 2.0 Token Exchange Processor policy.
OauthTokenExchangeProcessorAPIDeleteOauthTokenExchangeProcessorPolicyyDelete /oauth/tokenExchange/processor/policies/{id}Delete an OAuth 2.0 Token Exchange Processor policy.
OauthTokenExchangeProcessorAPIGetOauthTokenExchangeProcessorPolicyByIdGet /oauth/tokenExchange/processor/policies/{id}Find an OAuth 2.0 Token Exchange Processor policy by ID.
OauthTokenExchangeProcessorAPIGetOauthTokenExchangeProcessorPolicyPoliciesGet /oauth/tokenExchange/processor/policiesGet list of OAuth 2.0 Token Exchange Processor policies.
OauthTokenExchangeProcessorAPIGetOauthTokenExchangeProcessorPolicySettingsGet /oauth/tokenExchange/processor/settingsGet general OAuth 2.0 Token Exchange Processor settings.
OauthTokenExchangeProcessorAPIUpdateOauthTokenExchangeProcessorPolicyPut /oauth/tokenExchange/processor/policies/{id}Update an OAuth 2.0 Token Exchange Processor policy.
OauthTokenExchangeProcessorAPIUpdateOauthTokenExchangeProcessorPolicySettingsPut /oauth/tokenExchange/processor/settingsUpdate general OAuth 2.0 Token Exchange Processor settings.
OauthTokenExchangeTokenGeneratorMappingsAPICreateTokenGeneratorMappingPost /oauth/tokenExchange/tokenGeneratorMappingsCreate a new Token Exchange Processor policy to Token Generator Mapping.
OauthTokenExchangeTokenGeneratorMappingsAPIDeleteTokenGeneratorMappingByIdDelete /oauth/tokenExchange/tokenGeneratorMappings/{id}Delete a Token Exchange Processor policy to Token Generator Mapping.
OauthTokenExchangeTokenGeneratorMappingsAPIGetTokenGeneratorMappingByIdGet /oauth/tokenExchange/tokenGeneratorMappings/{id}Get a Token Exchange Processor policy to Token Generator Mapping.
OauthTokenExchangeTokenGeneratorMappingsAPIGetTokenGeneratorMappingsGet /oauth/tokenExchange/tokenGeneratorMappingsGet the list of Token Exchange Processor policy to Token Generator Mappings.
OauthTokenExchangeTokenGeneratorMappingsAPIUpdateTokenGeneratorMappingByIdPut /oauth/tokenExchange/tokenGeneratorMappings/{id}Update a Token Exchange Processor policy to Token Generator Mapping.
PasswordCredentialValidatorsAPICreatePasswordCredentialValidatorPost /passwordCredentialValidatorsCreate a new password credential validator instance
PasswordCredentialValidatorsAPIDeletePasswordCredentialValidatorDelete /passwordCredentialValidators/{id}Delete a password credential validator instance.
PasswordCredentialValidatorsAPIGetPasswordCredentialValidatorGet /passwordCredentialValidators/{id}Find a password credential validator by ID.
PasswordCredentialValidatorsAPIGetPasswordCredentialValidatorDescriptorGet /passwordCredentialValidators/descriptors/{id}Get the description of a password credential validator by ID.
PasswordCredentialValidatorsAPIGetPasswordCredentialValidatorDescriptorsGet /passwordCredentialValidators/descriptorsGet a list of available password credential validator descriptors.
PasswordCredentialValidatorsAPIGetPasswordCredentialValidatorsGet /passwordCredentialValidatorsGet the list of available password credential validators
PasswordCredentialValidatorsAPIUpdatePasswordCredentialValidatorPut /passwordCredentialValidators/{id}Update a password credential validator instance.
PingOneConnectionsAPICreatePingOneConnectionPost /pingOneConnectionsCreate a new PingOne connection.
PingOneConnectionsAPIDeletePingOneConnectionDelete /pingOneConnections/{id}Delete a PingOne connection.
PingOneConnectionsAPIGetCredentialStatusGet /pingOneConnections/{id}/credentialStatusGet the status of the credential associated with the PingOne connection
PingOneConnectionsAPIGetPingOneConnectionGet /pingOneConnections/{id}Get a PingOne connection with the specified ID.
PingOneConnectionsAPIGetPingOneConnectionAssociationsGet /pingOneConnections/{id}/serviceAssociationsGet information about components using this connection to access PingOne services.
PingOneConnectionsAPIGetPingOneConnectionEnvironmentsGet /pingOneConnections/{id}/environmentsGet the list of environments that the PingOne connection has access to.
PingOneConnectionsAPIGetPingOneConnectionUsagesGet /pingOneConnections/{id}/usageGet the list of resources that reference this PingOne connection.
PingOneConnectionsAPIGetPingOneConnectionsGet /pingOneConnectionsGet the list of all PingOne connections.
PingOneConnectionsAPIUpdatePingOneConnectionPut /pingOneConnections/{id}Update a PingOne connection.
PingOneForEnterpriseAPIDisconnectPost /pingOneForEnterprise/disconnectDisconnect from PingOne for Enterprise
PingOneForEnterpriseAPIGetKeyPairsGet /pingOneForEnterprise/keyPairsGet the PingOne for Enterprise key pair settings
PingOneForEnterpriseAPIGetPingOneForEnterpriseSettingsGet /pingOneForEnterpriseGet the PingOne for Enterprise settings
PingOneForEnterpriseAPIRotateKeysPost /pingOneForEnterprise/keyPairs/rotateRotate the authentication key
PingOneForEnterpriseAPIUpdatePingOneForEnterpriseIdentityRepositoryPost /pingOneForEnterprise/updateIdentityRepositoryUpdate the PingOne Identity Repository
PingOneForEnterpriseAPIUpdatePingOneSettingsPut /pingOneForEnterpriseUpdate the PingOne for Enterprise settings.
ProtocolMetadataAPIGetLifetimeSettingsGet /protocolMetadata/lifetimeSettingsGet metadata cache duration and reload delay for automated reloading.
ProtocolMetadataAPIGetSigningSettingsGet /protocolMetadata/signingSettingsGet the certificate ID and algorithm used for metadata signing.
ProtocolMetadataAPIUpdateLifetimeSettingsPut /protocolMetadata/lifetimeSettingsUpdate metadata cache duration and reload delay for automated reloading.
ProtocolMetadataAPIUpdateSigningSettingsPut /protocolMetadata/signingSettingsUpdate the certificate and algorithm for metadata signing.
RedirectValidationAPIGetRedirectValidationSettingsGet /redirectValidationRetrieve redirect validation settings.
RedirectValidationAPIUpdateRedirectValidationSettingsPut /redirectValidationUpdate redirect validation settings.
SecretManagersAPICreateSecretManagerPost /secretManagersCreate a secret manager plugin instance.
SecretManagersAPIDeleteSecretManagerDelete /secretManagers/{id}Delete a secret manager plugin instance.
SecretManagersAPIGetSecretManagerGet /secretManagers/{id}Get a specific secret manager plugin instance.
SecretManagersAPIGetSecretManagerPluginDescriptorGet /secretManagers/descriptors/{id}Get a secret manager plugin descriptor.
SecretManagersAPIGetSecretManagerPluginDescriptorsGet /secretManagers/descriptorsGet a list of available secret manager plugin descriptors.
SecretManagersAPIGetSecretManagersGet /secretManagersGet a list of secret manager plugin instances.
SecretManagersAPIGetSecretManagersActionGet /secretManagers/{id}/actions/{actionId}Get a secret manager plugin instance's action by ID.
SecretManagersAPIGetSecretManagersActionsGet /secretManagers/{id}/actionsGet a list of actions for a secret manager plugin instance.
SecretManagersAPIInvokeSecretManagersActionWithOptionsPost /secretManagers/{id}/actions/{actionId}/invokeActionInvokes an action for secret manager plugin instance.
SecretManagersAPIUpdateSecretManagerPut /secretManagers/{id}Update a secret manager plugin instance.
ServerSettingsAPIDeleteCertificateDelete /serverSettings/wsTrustStsSettings/issuerCertificates/{id}Delete a certificate from WS-Trust STS Settings.
ServerSettingsAPIGetCaptchaSettingsGet /serverSettings/captchaSettings(Deprecated) Gets the CAPTCHA settings.
ServerSettingsAPIGetCertGet /serverSettings/wsTrustStsSettings/issuerCertificates/{id}Retrieve details of a certificate.
ServerSettingsAPIGetCertsGet /serverSettings/wsTrustStsSettings/issuerCertificatesGet the list of certificates for WS-Trust STS Settings.
ServerSettingsAPIGetEmailServerSettingsGet /serverSettings/emailServer(Deprecated) Gets the email server settings
ServerSettingsAPIGetGeneralSettingsGet /serverSettings/generalSettingsGets the general settings.
ServerSettingsAPIGetLogSettingsGet /serverSettings/logSettingsGets the log settings.
ServerSettingsAPIGetNotificationSettingsGet /serverSettings/notificationsGets the notification settings
ServerSettingsAPIGetOutBoundProvisioningSettingsGet /serverSettings/outboundProvisioningGet database used for outbound provisioning
ServerSettingsAPIGetServerSettingsGet /serverSettingsGets the server settings
ServerSettingsAPIGetSystemKeysGet /serverSettings/systemKeysGet the system keys.
ServerSettingsAPIGetWsTrustStsSettingsGet /serverSettings/wsTrustStsSettingsGet the current WS-Trust STS Settings.
ServerSettingsAPIImportCertificatePost /serverSettings/wsTrustStsSettings/issuerCertificatesImport a new certificate.
ServerSettingsAPIRotateSystemKeysPost /serverSettings/systemKeys/rotateRotate the system keys.
ServerSettingsAPIUpdateCaptchaSettingsPut /serverSettings/captchaSettings(Deprecated) Update the CAPTCHA settings.
ServerSettingsAPIUpdateEmailServerSettingsPut /serverSettings/emailServer(Deprecated) Update the email server settings
ServerSettingsAPIUpdateGeneralSettingsPut /serverSettings/generalSettingsUpdate general settings.
ServerSettingsAPIUpdateLogSettingsPut /serverSettings/logSettingsUpdate log settings.
ServerSettingsAPIUpdateNotificationSettingsPut /serverSettings/notificationsUpdate the notification settings.
ServerSettingsAPIUpdateOutBoundProvisioningSettingsPut /serverSettings/outboundProvisioningUpdate database used for outbound provisioning
ServerSettingsAPIUpdateServerSettingsPut /serverSettingsUpdate the server settings.
ServerSettingsAPIUpdateSystemKeysPut /serverSettings/systemKeysUpdate the system keys.
ServerSettingsAPIUpdateWsTrustStsSettingsPut /serverSettings/wsTrustStsSettingsUpdate WS-Trust STS Settings.
ServiceAuthenticationAPIGetServiceAuthenticationGet /serviceAuthenticationGet the service authentication settings.
ServiceAuthenticationAPIUpdateServiceAuthenticationPut /serviceAuthenticationUpdate the service authentication settings.
SessionAPICreateSourcePolicyPost /session/authenticationSessionPoliciesCreate a new session policy.
SessionAPIDeleteSourcePolicyDelete /session/authenticationSessionPolicies/{id}Delete a session policy.
SessionAPIGetApplicationPolicyGet /session/applicationSessionPolicyGet the application session policy.
SessionAPIGetGlobalPolicyGet /session/authenticationSessionPolicies/globalGet the global authentication session policy.
SessionAPIGetSessionSettingsGet /session/settingsGet general session management settings.
SessionAPIGetSourcePoliciesGet /session/authenticationSessionPoliciesGet list of session policies.
SessionAPIGetSourcePolicyGet /session/authenticationSessionPolicies/{id}Find session policy by ID.
SessionAPIUpdateApplicationPolicyPut /session/applicationSessionPolicyUpdate the application session policy.
SessionAPIUpdateGlobalPolicyPut /session/authenticationSessionPolicies/globalUpdate the global authentication session policy.
SessionAPIUpdateSessionSettingsPut /session/settingsUpdate general session management settings.
SessionAPIUpdateSourcePolicyPut /session/authenticationSessionPolicies/{id}Update a session policy.
SpAdaptersAPICreateSpAdapterPost /sp/adaptersCreate a new SP adapter instance.
SpAdaptersAPIDeleteSpAdapterDelete /sp/adapters/{id}Delete an SP adapter instance.
SpAdaptersAPIGetSpAdapterGet /sp/adapters/{id}Find an SP adapter instance by ID.
SpAdaptersAPIGetSpAdapterDescriptorsGet /sp/adapters/descriptorsGet the list of available SP adapter descriptors.
SpAdaptersAPIGetSpAdapterDescriptorsByIdGet /sp/adapters/descriptors/{id}Get the description of an SP adapter plugin by ID.
SpAdaptersAPIGetSpAdapterUrlMappingsGet /sp/adapters/urlMappings(Deprecated) List the mappings between URLs and adapter instances.
SpAdaptersAPIGetSpAdaptersGet /sp/adaptersGet the list of configured SP adapter instances.
SpAdaptersAPIGetSpAdaptersActionByIdGet /sp/adapters/{id}/actions/{actionId}Find an SP adapter instance's action by ID.
SpAdaptersAPIGetSpAdaptersActionsGet /sp/adapters/{id}/actionsList the actions for an SP adapter instance.
SpAdaptersAPIInvokeSpAdapterActionWithOptionsPost /sp/adapters/{id}/actions/{actionId}/invokeActionInvokes an action for an SP adapter instance.
SpAdaptersAPIUpdateSpAdapterPut /sp/adapters/{id}Update an SP adapter instance.
SpAdaptersAPIUpdateSpAdapterUrlMappingsPut /sp/adapters/urlMappings(Deprecated) Update the mappings between URLs and adapters instances.
SpAuthenticationPolicyContractMappingsAPICreateApcToSpAdapterMappingPost /sp/authenticationPolicyContractMappingsCreate a new APC-to-SP Adapter Mapping.
SpAuthenticationPolicyContractMappingsAPIDeleteApcToSpAdapterMappingByIdDelete /sp/authenticationPolicyContractMappings/{id}Delete an APC-to-SP Adapter Mapping.
SpAuthenticationPolicyContractMappingsAPIGetApcToSpAdapterMappingByIdGet /sp/authenticationPolicyContractMappings/{id}Get an APC-to-SP Adapter Mapping.
SpAuthenticationPolicyContractMappingsAPIGetApcToSpAdapterMappingsGet /sp/authenticationPolicyContractMappingsGet the list of APC-to-SP Adapter Mappings.
SpAuthenticationPolicyContractMappingsAPIUpdateApcToSpAdapterMappingByIdPut /sp/authenticationPolicyContractMappings/{id}Update an APC-to-SP Adapter Mapping.
SpDefaultUrlsAPIGetSpDefaultUrlsGet /sp/defaultUrlsGets the SP Default URLs. These are Values that affect the user's experience when executing SP-initiated SSO operations.
SpDefaultUrlsAPIUpdateSpDefaultUrlsPut /sp/defaultUrlsUpdate the SP Default URLs. Enter values that affect the user's experience when executing SP-initiated SSO operations.
SpIdpConnectionsAPIAddConnectionCertPost /sp/idpConnections/{id}/credentials/certsAdd a new IdP connection certificate.
SpIdpConnectionsAPICreateConnectionPost /sp/idpConnectionsCreate a new IdP connection.
SpIdpConnectionsAPIDeleteConnectionDelete /sp/idpConnections/{id}Delete an IdP connection.
SpIdpConnectionsAPIGetConnectionGet /sp/idpConnections/{id}Find IdP connection by ID.
SpIdpConnectionsAPIGetConnectionCertsGet /sp/idpConnections/{id}/credentials/certsGet the IdP connection's certificates.
SpIdpConnectionsAPIGetConnectionsGet /sp/idpConnectionsGet list of IdP connections.
SpIdpConnectionsAPIGetIdpConnectionSigningSettingsGet /sp/idpConnections/{id}/credentials/signingSettingsGet the IdP connection's signature settings.
SpIdpConnectionsAPIGetIdpConnectionsDecryptionKeysGet /sp/idpConnections/{id}/credentials/decryptionKeysGet the decryption keys of an IdP connection.
SpIdpConnectionsAPIUpdateConnectionPut /sp/idpConnections/{id}Update an IdP connection.
SpIdpConnectionsAPIUpdateConnectionCertsPut /sp/idpConnections/{id}/credentials/certsUpdate the IdP connection's certificates.
SpIdpConnectionsAPIUpdateIdpConnectionSigningSettingsPut /sp/idpConnections/{id}/credentials/signingSettingsUpdate the IdP connection's signature settings.
SpIdpConnectionsAPIUpdateIdpConnectionsDecryptionKeysPut /sp/idpConnections/{id}/credentials/decryptionKeysUpdating the IdP connection's decryption keys.
SpTargetUrlMappingsAPIGetSpUrlMappingsGet /sp/targetUrlMappingsList the mappings between URLs and adapter or connection instances.
SpTargetUrlMappingsAPIUpdateSpUrlMappingsPut /sp/targetUrlMappingsUpdate the mappings between URLs and adapters or connections instances.
SpTokenGeneratorsAPICreateTokenGeneratorPost /sp/tokenGeneratorsCreate a new token generator instance.
SpTokenGeneratorsAPIDeleteTokenGeneratorDelete /sp/tokenGenerators/{id}Delete a token generator instance.
SpTokenGeneratorsAPIGetTokenGeneratorGet /sp/tokenGenerators/{id}Find a token generator instance by ID.
SpTokenGeneratorsAPIGetTokenGeneratorDescriptorsGet /sp/tokenGenerators/descriptorsGet the list of available token generators.
SpTokenGeneratorsAPIGetTokenGeneratorDescriptorsByIdGet /sp/tokenGenerators/descriptors/{id}Get the description of a token generator plugin by ID.
SpTokenGeneratorsAPIGetTokenGeneratorsGet /sp/tokenGeneratorsGet the list of token generator instances.
SpTokenGeneratorsAPIUpdateTokenGeneratorPut /sp/tokenGenerators/{id}Update a token generator instance.
TokenProcessorToTokenGeneratorMappingsAPICreateTokenToTokenMappingPost /tokenProcessorToTokenGeneratorMappingsCreate a new Token Processor to Token Generator Mapping.
TokenProcessorToTokenGeneratorMappingsAPIDeleteTokenToTokenMappingByIdDelete /tokenProcessorToTokenGeneratorMappings/{id}Delete a Token Processor to Token Generator Mapping.
TokenProcessorToTokenGeneratorMappingsAPIGetTokenToTokenMappingByIdGet /tokenProcessorToTokenGeneratorMappings/{id}Get a Token Processor to Token Generator Mapping.
TokenProcessorToTokenGeneratorMappingsAPIGetTokenToTokenMappingsGet /tokenProcessorToTokenGeneratorMappingsGet the list of Token Processor to Token Generator Mappings.
TokenProcessorToTokenGeneratorMappingsAPIUpdateTokenToTokenMappingByIdPut /tokenProcessorToTokenGeneratorMappings/{id}Update a Token Processor to Token Generator Mapping.
VersionAPIGetVersionGet /versionGets the server version.
VirtualHostNamesAPIGetVirtualHostNamesSettingsGet /virtualHostNamesRetrieve virtual host names settings.
VirtualHostNamesAPIUpdateVirtualHostNamesSettingsPut /virtualHostNamesUpdate virtual host names settings.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BasicAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author