@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-07-14T17:07:26.321-05:00[America/Chicago]") public class IdentityProviderApi extends Object
Constructor and Description |
---|
IdentityProviderApi() |
IdentityProviderApi(ApiClient apiClient) |
Modifier and Type | Method and Description |
---|---|
IdentityProvider |
activateIdentityProvider(String idpId)
Activate an Identity Provider
Activates an inactive IdP
|
IdentityProvider |
activateIdentityProvider(String idpId,
Map<String,String> additionalHeaders)
Activate an Identity Provider
Activates an inactive IdP
|
JsonWebKey |
cloneIdentityProviderKey(String idpId,
String idpKeyId,
String targetIdpId)
Clone a Signing Credential Key
Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP
|
JsonWebKey |
cloneIdentityProviderKey(String idpId,
String idpKeyId,
String targetIdpId,
Map<String,String> additionalHeaders)
Clone a Signing Credential Key
Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP
|
IdentityProvider |
createIdentityProvider(IdentityProvider identityProvider)
Create an Identity Provider
Creates a new identity provider integration
|
IdentityProvider |
createIdentityProvider(IdentityProvider identityProvider,
Map<String,String> additionalHeaders)
Create an Identity Provider
Creates a new identity provider integration
|
JsonWebKey |
createIdentityProviderKey(JsonWebKey jsonWebKey)
Create an X.509 Certificate Public Key
Creates a new X.509 certificate credential to the IdP key store.
|
JsonWebKey |
createIdentityProviderKey(JsonWebKey jsonWebKey,
Map<String,String> additionalHeaders)
Create an X.509 Certificate Public Key
Creates a new X.509 certificate credential to the IdP key store.
|
IdentityProvider |
deactivateIdentityProvider(String idpId)
Deactivate an Identity Provider
Deactivates an active IdP
|
IdentityProvider |
deactivateIdentityProvider(String idpId,
Map<String,String> additionalHeaders)
Deactivate an Identity Provider
Deactivates an active IdP
|
void |
deleteIdentityProvider(String idpId)
Delete an Identity Provider
Deletes an identity provider integration by `idpId`
|
void |
deleteIdentityProvider(String idpId,
Map<String,String> additionalHeaders)
Delete an Identity Provider
Deletes an identity provider integration by `idpId`
|
void |
deleteIdentityProviderKey(String idpKeyId)
Delete a Signing Credential Key
Deletes a specific IdP Key Credential by `kid` if it is not currently being used by an Active or Inactive IdP
|
void |
deleteIdentityProviderKey(String idpKeyId,
Map<String,String> additionalHeaders)
Delete a Signing Credential Key
Deletes a specific IdP Key Credential by `kid` if it is not currently being used by an Active or Inactive IdP
|
Csr |
generateCsrForIdentityProvider(String idpId,
CsrMetadata metadata)
Generate a Certificate Signing Request
Generates a new key pair and returns a Certificate Signing Request for it
|
Csr |
generateCsrForIdentityProvider(String idpId,
CsrMetadata metadata,
Map<String,String> additionalHeaders)
Generate a Certificate Signing Request
Generates a new key pair and returns a Certificate Signing Request for it
|
JsonWebKey |
generateIdentityProviderSigningKey(String idpId,
Integer validityYears)
Generate a new Signing Credential Key
Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP
|
JsonWebKey |
generateIdentityProviderSigningKey(String idpId,
Integer validityYears,
Map<String,String> additionalHeaders)
Generate a new Signing Credential Key
Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP
|
ApiClient |
getApiClient() |
Csr |
getCsrForIdentityProvider(String idpId,
String idpCsrId)
Retrieve a Certificate Signing Request
Retrieves a specific Certificate Signing Request model by id
|
Csr |
getCsrForIdentityProvider(String idpId,
String idpCsrId,
Map<String,String> additionalHeaders)
Retrieve a Certificate Signing Request
Retrieves a specific Certificate Signing Request model by id
|
IdentityProvider |
getIdentityProvider(String idpId)
Retrieve an Identity Provider
Retrieves an identity provider integration by `idpId`
|
IdentityProvider |
getIdentityProvider(String idpId,
Map<String,String> additionalHeaders)
Retrieve an Identity Provider
Retrieves an identity provider integration by `idpId`
|
IdentityProviderApplicationUser |
getIdentityProviderApplicationUser(String idpId,
String userId)
Retrieve a User
Retrieves a linked IdP user by ID
|
IdentityProviderApplicationUser |
getIdentityProviderApplicationUser(String idpId,
String userId,
Map<String,String> additionalHeaders)
Retrieve a User
Retrieves a linked IdP user by ID
|
JsonWebKey |
getIdentityProviderKey(String idpKeyId)
Retrieve an Credential Key
Retrieves a specific IdP Key Credential by `kid`
|
JsonWebKey |
getIdentityProviderKey(String idpKeyId,
Map<String,String> additionalHeaders)
Retrieve an Credential Key
Retrieves a specific IdP Key Credential by `kid`
|
JsonWebKey |
getIdentityProviderSigningKey(String idpId,
String idpKeyId)
Retrieve a Signing Credential Key
Retrieves a specific IdP Key Credential by `kid`
|
JsonWebKey |
getIdentityProviderSigningKey(String idpId,
String idpKeyId,
Map<String,String> additionalHeaders)
Retrieve a Signing Credential Key
Retrieves a specific IdP Key Credential by `kid`
|
protected static com.fasterxml.jackson.databind.ObjectMapper |
getObjectMapper() |
IdentityProviderApplicationUser |
linkUserToIdentityProvider(String idpId,
String userId,
UserIdentityProviderLinkRequest userIdentityProviderLinkRequest)
Link a User to a Social IdP
Links an Okta user to an existing Social Identity Provider.
|
IdentityProviderApplicationUser |
linkUserToIdentityProvider(String idpId,
String userId,
UserIdentityProviderLinkRequest userIdentityProviderLinkRequest,
Map<String,String> additionalHeaders)
Link a User to a Social IdP
Links an Okta user to an existing Social Identity Provider.
|
List<Csr> |
listCsrsForIdentityProvider(String idpId)
List all Certificate Signing Requests
Lists all Certificate Signing Requests for an IdP
|
List<Csr> |
listCsrsForIdentityProvider(String idpId,
Map<String,String> additionalHeaders)
List all Certificate Signing Requests
Lists all Certificate Signing Requests for an IdP
|
List<IdentityProviderApplicationUser> |
listIdentityProviderApplicationUsers(String idpId)
List all Users
Lists all users linked to the identity provider
|
List<IdentityProviderApplicationUser> |
listIdentityProviderApplicationUsers(String idpId,
Map<String,String> additionalHeaders)
List all Users
Lists all users linked to the identity provider
|
List<JsonWebKey> |
listIdentityProviderKeys(String after,
Integer limit)
List all Credential Keys
Lists all IdP key credentials
|
List<JsonWebKey> |
listIdentityProviderKeys(String after,
Integer limit,
Map<String,String> additionalHeaders)
List all Credential Keys
Lists all IdP key credentials
|
List<IdentityProvider> |
listIdentityProviders(String q,
String after,
Integer limit,
String type)
List all Identity Providers
Lists all identity provider integrations with pagination.
|
List<IdentityProvider> |
listIdentityProviders(String q,
String after,
Integer limit,
String type,
Map<String,String> additionalHeaders)
List all Identity Providers
Lists all identity provider integrations with pagination.
|
List<JsonWebKey> |
listIdentityProviderSigningKeys(String idpId)
List all Signing Credential Keys
Lists all signing key credentials for an IdP
|
List<JsonWebKey> |
listIdentityProviderSigningKeys(String idpId,
Map<String,String> additionalHeaders)
List all Signing Credential Keys
Lists all signing key credentials for an IdP
|
List<SocialAuthToken> |
listSocialAuthTokens(String idpId,
String userId)
List all Tokens from a OIDC Identity Provider
Lists the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth
|
List<SocialAuthToken> |
listSocialAuthTokens(String idpId,
String userId,
Map<String,String> additionalHeaders)
List all Tokens from a OIDC Identity Provider
Lists the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth
|
JsonWebKey |
publishCsrForIdentityProvider(String idpId,
String idpCsrId,
File body)
Publish a Certificate Signing Request
Publishes a certificate signing request with a signed X.509 certificate and adds it into the signing key credentials for the IdP
|
JsonWebKey |
publishCsrForIdentityProvider(String idpId,
String idpCsrId,
File body,
Map<String,String> additionalHeaders)
Publish a Certificate Signing Request
Publishes a certificate signing request with a signed X.509 certificate and adds it into the signing key credentials for the IdP
|
IdentityProvider |
replaceIdentityProvider(String idpId,
IdentityProvider identityProvider)
Replace an Identity Provider
Replaces an identity provider integration by `idpId`
|
IdentityProvider |
replaceIdentityProvider(String idpId,
IdentityProvider identityProvider,
Map<String,String> additionalHeaders)
Replace an Identity Provider
Replaces an identity provider integration by `idpId`
|
void |
revokeCsrForIdentityProvider(String idpId,
String idpCsrId)
Revoke a Certificate Signing Request
Revokes a certificate signing request and deletes the key pair from the IdP
|
void |
revokeCsrForIdentityProvider(String idpId,
String idpCsrId,
Map<String,String> additionalHeaders)
Revoke a Certificate Signing Request
Revokes a certificate signing request and deletes the key pair from the IdP
|
void |
setApiClient(ApiClient apiClient) |
void |
unlinkUserFromIdentityProvider(String idpId,
String userId)
Unlink a User from IdP
Unlinks the link between the Okta user and the IdP user
|
void |
unlinkUserFromIdentityProvider(String idpId,
String userId,
Map<String,String> additionalHeaders)
Unlink a User from IdP
Unlinks the link between the Okta user and the IdP user
|
public IdentityProviderApi()
public IdentityProviderApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public IdentityProvider activateIdentityProvider(String idpId) throws ApiException
idpId
- `id` of IdP (required)ApiException
- if fails to make API callpublic IdentityProvider activateIdentityProvider(String idpId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic JsonWebKey cloneIdentityProviderKey(String idpId, String idpKeyId, String targetIdpId) throws ApiException
idpId
- `id` of IdP (required)idpKeyId
- `id` of IdP Key (required)targetIdpId
- (required)ApiException
- if fails to make API callpublic JsonWebKey cloneIdentityProviderKey(String idpId, String idpKeyId, String targetIdpId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)idpKeyId
- `id` of IdP Key (required)targetIdpId
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic IdentityProvider createIdentityProvider(IdentityProvider identityProvider) throws ApiException
identityProvider
- (required)ApiException
- if fails to make API callpublic IdentityProvider createIdentityProvider(IdentityProvider identityProvider, Map<String,String> additionalHeaders) throws ApiException
identityProvider
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic JsonWebKey createIdentityProviderKey(JsonWebKey jsonWebKey) throws ApiException
jsonWebKey
- (required)ApiException
- if fails to make API callpublic JsonWebKey createIdentityProviderKey(JsonWebKey jsonWebKey, Map<String,String> additionalHeaders) throws ApiException
jsonWebKey
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic IdentityProvider deactivateIdentityProvider(String idpId) throws ApiException
idpId
- `id` of IdP (required)ApiException
- if fails to make API callpublic IdentityProvider deactivateIdentityProvider(String idpId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic void deleteIdentityProvider(String idpId) throws ApiException
idpId
- `id` of IdP (required)ApiException
- if fails to make API callpublic void deleteIdentityProvider(String idpId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic void deleteIdentityProviderKey(String idpKeyId) throws ApiException
idpKeyId
- `id` of IdP Key (required)ApiException
- if fails to make API callpublic void deleteIdentityProviderKey(String idpKeyId, Map<String,String> additionalHeaders) throws ApiException
idpKeyId
- `id` of IdP Key (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic Csr generateCsrForIdentityProvider(String idpId, CsrMetadata metadata) throws ApiException
idpId
- `id` of IdP (required)metadata
- (required)ApiException
- if fails to make API callpublic Csr generateCsrForIdentityProvider(String idpId, CsrMetadata metadata, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)metadata
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic JsonWebKey generateIdentityProviderSigningKey(String idpId, Integer validityYears) throws ApiException
idpId
- `id` of IdP (required)validityYears
- expiry of the IdP Key Credential (required)ApiException
- if fails to make API callpublic JsonWebKey generateIdentityProviderSigningKey(String idpId, Integer validityYears, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)validityYears
- expiry of the IdP Key Credential (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic Csr getCsrForIdentityProvider(String idpId, String idpCsrId) throws ApiException
idpId
- `id` of IdP (required)idpCsrId
- `id` of the IdP CSR (required)ApiException
- if fails to make API callpublic Csr getCsrForIdentityProvider(String idpId, String idpCsrId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)idpCsrId
- `id` of the IdP CSR (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic IdentityProvider getIdentityProvider(String idpId) throws ApiException
idpId
- `id` of IdP (required)ApiException
- if fails to make API callpublic IdentityProvider getIdentityProvider(String idpId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic IdentityProviderApplicationUser getIdentityProviderApplicationUser(String idpId, String userId) throws ApiException
idpId
- `id` of IdP (required)userId
- (required)ApiException
- if fails to make API callpublic IdentityProviderApplicationUser getIdentityProviderApplicationUser(String idpId, String userId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)userId
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic JsonWebKey getIdentityProviderKey(String idpKeyId) throws ApiException
idpKeyId
- `id` of IdP Key (required)ApiException
- if fails to make API callpublic JsonWebKey getIdentityProviderKey(String idpKeyId, Map<String,String> additionalHeaders) throws ApiException
idpKeyId
- `id` of IdP Key (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic JsonWebKey getIdentityProviderSigningKey(String idpId, String idpKeyId) throws ApiException
idpId
- `id` of IdP (required)idpKeyId
- `id` of IdP Key (required)ApiException
- if fails to make API callpublic JsonWebKey getIdentityProviderSigningKey(String idpId, String idpKeyId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)idpKeyId
- `id` of IdP Key (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic IdentityProviderApplicationUser linkUserToIdentityProvider(String idpId, String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest) throws ApiException
idpId
- `id` of IdP (required)userId
- (required)userIdentityProviderLinkRequest
- (required)ApiException
- if fails to make API callpublic IdentityProviderApplicationUser linkUserToIdentityProvider(String idpId, String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)userId
- (required)userIdentityProviderLinkRequest
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<Csr> listCsrsForIdentityProvider(String idpId) throws ApiException
idpId
- `id` of IdP (required)ApiException
- if fails to make API callpublic List<Csr> listCsrsForIdentityProvider(String idpId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<IdentityProviderApplicationUser> listIdentityProviderApplicationUsers(String idpId) throws ApiException
idpId
- `id` of IdP (required)ApiException
- if fails to make API callpublic List<IdentityProviderApplicationUser> listIdentityProviderApplicationUsers(String idpId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<JsonWebKey> listIdentityProviderKeys(String after, Integer limit) throws ApiException
after
- Specifies the pagination cursor for the next page of keys (optional)limit
- Specifies the number of key results in a page (optional, default to 20)ApiException
- if fails to make API callpublic List<JsonWebKey> listIdentityProviderKeys(String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
after
- Specifies the pagination cursor for the next page of keys (optional)limit
- Specifies the number of key results in a page (optional, default to 20)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<JsonWebKey> listIdentityProviderSigningKeys(String idpId) throws ApiException
idpId
- `id` of IdP (required)ApiException
- if fails to make API callpublic List<JsonWebKey> listIdentityProviderSigningKeys(String idpId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<IdentityProvider> listIdentityProviders(String q, String after, Integer limit, String type) throws ApiException
q
- Searches the name property of IdPs for matching value (optional)after
- Specifies the pagination cursor for the next page of IdPs (optional)limit
- Specifies the number of IdP results in a page (optional, default to 20)type
- Filters IdPs by type (optional)ApiException
- if fails to make API callpublic List<IdentityProvider> listIdentityProviders(String q, String after, Integer limit, String type, Map<String,String> additionalHeaders) throws ApiException
q
- Searches the name property of IdPs for matching value (optional)after
- Specifies the pagination cursor for the next page of IdPs (optional)limit
- Specifies the number of IdP results in a page (optional, default to 20)type
- Filters IdPs by type (optional)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<SocialAuthToken> listSocialAuthTokens(String idpId, String userId) throws ApiException
idpId
- `id` of IdP (required)userId
- (required)ApiException
- if fails to make API callpublic List<SocialAuthToken> listSocialAuthTokens(String idpId, String userId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)userId
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic JsonWebKey publishCsrForIdentityProvider(String idpId, String idpCsrId, File body) throws ApiException
idpId
- `id` of IdP (required)idpCsrId
- `id` of the IdP CSR (required)body
- (required)ApiException
- if fails to make API callpublic JsonWebKey publishCsrForIdentityProvider(String idpId, String idpCsrId, File body, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)idpCsrId
- `id` of the IdP CSR (required)body
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic IdentityProvider replaceIdentityProvider(String idpId, IdentityProvider identityProvider) throws ApiException
idpId
- `id` of IdP (required)identityProvider
- (required)ApiException
- if fails to make API callpublic IdentityProvider replaceIdentityProvider(String idpId, IdentityProvider identityProvider, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)identityProvider
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic void revokeCsrForIdentityProvider(String idpId, String idpCsrId) throws ApiException
idpId
- `id` of IdP (required)idpCsrId
- `id` of the IdP CSR (required)ApiException
- if fails to make API callpublic void revokeCsrForIdentityProvider(String idpId, String idpCsrId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)idpCsrId
- `id` of the IdP CSR (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic void unlinkUserFromIdentityProvider(String idpId, String userId) throws ApiException
idpId
- `id` of IdP (required)userId
- (required)ApiException
- if fails to make API callpublic void unlinkUserFromIdentityProvider(String idpId, String userId, Map<String,String> additionalHeaders) throws ApiException
idpId
- `id` of IdP (required)userId
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callprotected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()
Copyright © 2017–2023 Okta. All rights reserved.