Interface IIdentityProvider

Represents a IdentityProvider resource in the Okta API.

Inherited Members

IResource.Item[String]

IResource.GetArrayProperty<T>(String)

IResource.GetData()

IResource.SetProperty(String, Object)

IResource.GetProperty<T>(String)

Namespace: Okta.Sdk

Assembly: Okta.Sdk.dll

Syntax

public interface IIdentityProvider : IResource

Properties

Created

Declaration

DateTimeOffset? Created { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Id

Declaration

string Id { get; }

Property Value

Type	Description
System.String

IssuerMode

Declaration

string IssuerMode { get; set; }

Property Value

Type	Description
System.String

LastUpdated

Declaration

DateTimeOffset? LastUpdated { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Name

Declaration

string Name { get; set; }

Property Value

Type	Description
System.String

Policy

Declaration

IIdentityProviderPolicy Policy { get; set; }

Property Value

Type	Description
IIdentityProviderPolicy

Protocol

Declaration

IProtocol Protocol { get; set; }

Property Value

Type	Description
IProtocol

Status

Declaration

string Status { get; set; }

Property Value

Type	Description
System.String

Type

Declaration

string Type { get; set; }

Property Value

Type	Description
System.String

Methods

ActivateAsync(CancellationToken)

Declaration

Task<IIdentityProvider> ActivateAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<IIdentityProvider>

CloneKeyAsync(String, String, CancellationToken)

Declaration

Task<IJsonWebKey> CloneKeyAsync(string keyId, string targetIdpId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	keyId
System.String	targetIdpId
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<IJsonWebKey>

DeactivateAsync(CancellationToken)

Declaration

Task<IIdentityProvider> DeactivateAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<IIdentityProvider>

DeleteSigningCsrAsync(String, CancellationToken)

Declaration

Task DeleteSigningCsrAsync(string csrId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	csrId
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

GenerateCsrAsync(ICsrMetadata, CancellationToken)

Declaration

Task<ICsr> GenerateCsrAsync(ICsrMetadata metadata, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ICsrMetadata	metadata
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<ICsr>

GenerateSigningKeyAsync(Nullable<Int32>, CancellationToken)

Declaration

Task<IJsonWebKey> GenerateSigningKeyAsync(int? validityYears, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Nullable<System.Int32>	validityYears
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<IJsonWebKey>

GetSigningCsrAsync(String, CancellationToken)

Declaration

Task<ICsr> GetSigningCsrAsync(string csrId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	csrId
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<ICsr>

GetSigningKeyAsync(String, CancellationToken)

Declaration

Task<IJsonWebKey> GetSigningKeyAsync(string keyId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	keyId
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<IJsonWebKey>

GetUserAsync(String, CancellationToken)

Declaration

Task<IIdentityProviderApplicationUser> GetUserAsync(string userId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	userId
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<IIdentityProviderApplicationUser>

LinkUserAsync(IUserIdentityProviderLinkRequest, String, CancellationToken)

Declaration

Task<IIdentityProviderApplicationUser> LinkUserAsync(IUserIdentityProviderLinkRequest userIdentityProviderLinkRequest, string userId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IUserIdentityProviderLinkRequest	userIdentityProviderLinkRequest
System.String	userId
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<IIdentityProviderApplicationUser>

ListSigningCsrs()

Declaration

ICollectionClient<ICsr> ListSigningCsrs()

Returns

Type	Description
ICollectionClient<ICsr>

ListSigningKeys()

Declaration

ICollectionClient<IJsonWebKey> ListSigningKeys()

Returns

Type	Description
ICollectionClient<IJsonWebKey>

ListSocialAuthTokens(String)

Declaration

ICollectionClient<ISocialAuthToken> ListSocialAuthTokens(string userId)

Parameters

Type	Name	Description
System.String	userId

Returns

Type	Description
ICollectionClient<ISocialAuthToken>

ListUsers()

Declaration

ICollectionClient<IIdentityProviderApplicationUser> ListUsers()

Returns

Type	Description
ICollectionClient<IIdentityProviderApplicationUser>

UnlinkUserAsync(String, CancellationToken)

Declaration

Task UnlinkUserAsync(string userId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	userId
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task