Interface IIdentityProvidersClient
A client that works with Okta IdentityProvider resources.
Namespace: Okta.Sdk
Assembly: Okta.Sdk.dll
Syntax
public interface IIdentityProvidersClientMethods
ActivateIdentityProviderAsync(String, CancellationToken)
Activates an inactive IdP.
Declaration
Task<IIdentityProvider> ActivateIdentityProviderAsync(string idpId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IIdentityProvider> | The IIdentityProvider response. |
CloneIdentityProviderKeyAsync(String, String, String, CancellationToken)
Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP
Declaration
Task<IJsonWebKey> CloneIdentityProviderKeyAsync(string idpId, string keyId, string targetIdpId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId | |
| System.String | keyId | |
| System.String | targetIdpId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IJsonWebKey> | The IJsonWebKey response. |
CreateIdentityProviderAsync(IIdentityProvider, CancellationToken)
Adds a new IdP to your organization.
Declaration
Task<IIdentityProvider> CreateIdentityProviderAsync(IIdentityProvider identityProvider, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IIdentityProvider | identityProvider | The IIdentityProvider resource. |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IIdentityProvider> | The IIdentityProvider response. |
CreateIdentityProviderKeyAsync(IJsonWebKey, CancellationToken)
Adds a new X.509 certificate credential to the IdP key store.
Declaration
Task<IJsonWebKey> CreateIdentityProviderKeyAsync(IJsonWebKey jsonWebKey, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IJsonWebKey | jsonWebKey | The IJsonWebKey resource. |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IJsonWebKey> | The IJsonWebKey response. |
DeactivateIdentityProviderAsync(String, CancellationToken)
Deactivates an active IdP.
Declaration
Task<IIdentityProvider> DeactivateIdentityProviderAsync(string idpId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IIdentityProvider> | The IIdentityProvider response. |
DeleteIdentityProviderAsync(String, CancellationToken)
Removes an IdP from your organization.
Declaration
Task DeleteIdentityProviderAsync(string idpId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
DeleteIdentityProviderKeyAsync(String, CancellationToken)
Deletes a specific IdP Key Credential by kid if it is not currently being used by an Active or Inactive IdP.
Declaration
Task DeleteIdentityProviderKeyAsync(string keyId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | keyId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
GenerateCsrForIdentityProviderAsync(ICsrMetadata, String, CancellationToken)
Generates a new key pair and returns a Certificate Signing Request for it.
Declaration
Task<ICsr> GenerateCsrForIdentityProviderAsync(ICsrMetadata metadata, string idpId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| ICsrMetadata | metadata | The ICsrMetadata resource. |
| System.String | idpId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ICsr> | The ICsr response. |
GenerateIdentityProviderSigningKeyAsync(String, Nullable<Int32>, CancellationToken)
Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP
Declaration
Task<IJsonWebKey> GenerateIdentityProviderSigningKeyAsync(string idpId, int? validityYears, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId | |
| System.Nullable<System.Int32> | validityYears | expiry of the IdP Key Credential |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IJsonWebKey> | The IJsonWebKey response. |
GetCsrForIdentityProviderAsync(String, String, CancellationToken)
Gets a specific Certificate Signing Request model by id
Declaration
Task<ICsr> GetCsrForIdentityProviderAsync(string idpId, string csrId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId | |
| System.String | csrId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<ICsr> | The ICsr response. |
GetIdentityProviderApplicationUserAsync(String, String, CancellationToken)
Fetches a linked IdP user by ID
Declaration
Task<IIdentityProviderApplicationUser> GetIdentityProviderApplicationUserAsync(string idpId, string userId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId | |
| System.String | userId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IIdentityProviderApplicationUser> | The IIdentityProviderApplicationUser response. |
GetIdentityProviderAsync(String, CancellationToken)
Fetches an IdP by id.
Declaration
Task<IIdentityProvider> GetIdentityProviderAsync(string idpId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IIdentityProvider> | The IIdentityProvider response. |
GetIdentityProviderKeyAsync(String, CancellationToken)
Gets a specific IdP Key Credential by kid
Declaration
Task<IJsonWebKey> GetIdentityProviderKeyAsync(string keyId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | keyId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IJsonWebKey> | The IJsonWebKey response. |
GetIdentityProviderSigningKeyAsync(String, String, CancellationToken)
Gets a specific IdP Key Credential by kid
Declaration
Task<IJsonWebKey> GetIdentityProviderSigningKeyAsync(string idpId, string keyId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId | |
| System.String | keyId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IJsonWebKey> | The IJsonWebKey response. |
LinkUserToIdentityProviderAsync(IUserIdentityProviderLinkRequest, String, String, CancellationToken)
Links an Okta user to an existing Social Identity Provider. This does not support the SAML2 Identity Provider Type
Declaration
Task<IIdentityProviderApplicationUser> LinkUserToIdentityProviderAsync(IUserIdentityProviderLinkRequest userIdentityProviderLinkRequest, string idpId, string userId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IUserIdentityProviderLinkRequest | userIdentityProviderLinkRequest | The IUserIdentityProviderLinkRequest resource. |
| System.String | idpId | |
| System.String | userId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IIdentityProviderApplicationUser> | The IIdentityProviderApplicationUser response. |
ListCsrsForIdentityProvider(String)
Enumerates Certificate Signing Requests for an IdP
Declaration
ICollectionClient<ICsr> ListCsrsForIdentityProvider(string idpId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId |
Returns
| Type | Description |
|---|---|
| ICollectionClient<ICsr> | A collection of ICsr that can be enumerated asynchronously. |
ListIdentityProviderApplicationUsers(String)
Find all the users linked to an identity provider
Declaration
ICollectionClient<IIdentityProviderApplicationUser> ListIdentityProviderApplicationUsers(string idpId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId |
Returns
| Type | Description |
|---|---|
| ICollectionClient<IIdentityProviderApplicationUser> | A collection of IIdentityProviderApplicationUser that can be enumerated asynchronously. |
ListIdentityProviderKeys(String, Nullable<Int32>)
Enumerates IdP key credentials.
Declaration
ICollectionClient<IJsonWebKey> ListIdentityProviderKeys(string after = null, int? limit)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | after | Specifies the pagination cursor for the next page of keys |
| System.Nullable<System.Int32> | limit | Specifies the number of key results in a page |
Returns
| Type | Description |
|---|---|
| ICollectionClient<IJsonWebKey> | A collection of IJsonWebKey that can be enumerated asynchronously. |
ListIdentityProviders(String, String, Nullable<Int32>, String)
Enumerates IdPs in your organization with pagination. A subset of IdPs can be returned that match a supported filter expression or query.
Declaration
ICollectionClient<IIdentityProvider> ListIdentityProviders(string q = null, string after = null, int? limit, string type = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | q | Searches the name property of IdPs for matching value |
| System.String | after | Specifies the pagination cursor for the next page of IdPs |
| System.Nullable<System.Int32> | limit | Specifies the number of IdP results in a page |
| System.String | type | Filters IdPs by type |
Returns
| Type | Description |
|---|---|
| ICollectionClient<IIdentityProvider> | A collection of IIdentityProvider that can be enumerated asynchronously. |
ListIdentityProviderSigningKeys(String)
Enumerates signing key credentials for an IdP
Declaration
ICollectionClient<IJsonWebKey> ListIdentityProviderSigningKeys(string idpId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId |
Returns
| Type | Description |
|---|---|
| ICollectionClient<IJsonWebKey> | A collection of IJsonWebKey that can be enumerated asynchronously. |
ListSocialAuthTokens(String, String)
Fetches the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth.
Declaration
ICollectionClient<ISocialAuthToken> ListSocialAuthTokens(string idpId, string userId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId | |
| System.String | userId |
Returns
| Type | Description |
|---|---|
| ICollectionClient<ISocialAuthToken> | A collection of ISocialAuthToken that can be enumerated asynchronously. |
PublishBinaryCerCertForIdentityProviderAsync(Byte[], String, String, CancellationToken)
Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.
Declaration
Task<IJsonWebKey> PublishBinaryCerCertForIdentityProviderAsync(byte[] certificate, string idpId, string csrId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte[] | certificate | The |
| System.String | idpId | |
| System.String | csrId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IJsonWebKey> | The IJsonWebKey response. |
PublishBinaryDerCertForIdentityProviderAsync(Byte[], String, String, CancellationToken)
Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.
Declaration
Task<IJsonWebKey> PublishBinaryDerCertForIdentityProviderAsync(byte[] certificate, string idpId, string csrId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte[] | certificate | The |
| System.String | idpId | |
| System.String | csrId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IJsonWebKey> | The IJsonWebKey response. |
PublishBinaryPemCertForIdentityProviderAsync(Byte[], String, String, CancellationToken)
Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.
Declaration
Task<IJsonWebKey> PublishBinaryPemCertForIdentityProviderAsync(byte[] certificate, string idpId, string csrId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte[] | certificate | The |
| System.String | idpId | |
| System.String | csrId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IJsonWebKey> | The IJsonWebKey response. |
PublishCerCertForIdentityProviderAsync(String, String, String, CancellationToken)
Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.
Declaration
Task<IJsonWebKey> PublishCerCertForIdentityProviderAsync(string certificate, string idpId, string csrId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | certificate | The System.String resource. |
| System.String | idpId | |
| System.String | csrId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IJsonWebKey> | The IJsonWebKey response. |
PublishDerCertForIdentityProviderAsync(String, String, String, CancellationToken)
Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.
Declaration
Task<IJsonWebKey> PublishDerCertForIdentityProviderAsync(string certificate, string idpId, string csrId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | certificate | The System.String resource. |
| System.String | idpId | |
| System.String | csrId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IJsonWebKey> | The IJsonWebKey response. |
RevokeCsrForIdentityProviderAsync(String, String, CancellationToken)
Revoke a Certificate Signing Request and delete the key pair from the IdP
Declaration
Task RevokeCsrForIdentityProviderAsync(string idpId, string csrId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId | |
| System.String | csrId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
UnlinkUserFromIdentityProviderAsync(String, String, CancellationToken)
Removes the link between the Okta user and the IdP user.
Declaration
Task UnlinkUserFromIdentityProviderAsync(string idpId, string userId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.String | idpId | |
| System.String | userId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A Task that represents the asynchronous operation. |
UpdateIdentityProviderAsync(IIdentityProvider, String, CancellationToken)
Updates the configuration for an IdP.
Declaration
Task<IIdentityProvider> UpdateIdentityProviderAsync(IIdentityProvider identityProvider, string idpId, CancellationToken cancellationToken = default(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| IIdentityProvider | identityProvider | The IIdentityProvider resource. |
| System.String | idpId | |
| System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<IIdentityProvider> | The IIdentityProvider response. |