Class IdentityProvider

Represents a resource in the Okta API.

Inheritance

System.Object

Resource

IdentityProvider

Implements

IIdentityProvider

IResource

Inherited Members

Resource.GetClient()

Resource.GetData()

Resource.Item[String]

Resource.GetProperty<T>(String)

Resource.SetProperty(String, Object)

Resource.GetStringProperty(String)

Resource.GetBooleanProperty(String)

Resource.GetIntegerProperty(String)

Resource.GetLongProperty(String)

Resource.GetDoubleProperty(String)

Resource.GetDateTimeProperty(String)

Resource.GetArrayProperty<T>(String)

Resource.GetEnumProperty<TEnum>(String)

Resource.GetResourceProperty<T>(String)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Okta.Sdk

Assembly: Okta.Sdk.dll

Syntax

public sealed class IdentityProvider : Resource, IIdentityProvider, IResource

Properties

Created

Declaration

public DateTimeOffset? Created { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Id

Declaration

public string Id { get; }

Property Value

Type	Description
System.String

IssuerMode

Declaration

public string IssuerMode { get; set; }

Property Value

Type	Description
System.String

LastUpdated

Declaration

public DateTimeOffset? LastUpdated { get; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

Name

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

Policy

Declaration

public IIdentityProviderPolicy Policy { get; set; }

Property Value

Type	Description
IIdentityProviderPolicy

Protocol

Declaration

public IProtocol Protocol { get; set; }

Property Value

Type	Description
IProtocol

Status

Declaration

public string Status { get; set; }

Property Value

Type	Description
System.String

Type

Declaration

public string Type { get; set; }

Property Value

Type	Description
System.String

Methods

ActivateAsync(CancellationToken)

Declaration

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public ICollectionClient<ICsr> ListSigningCsrs()

Returns

Type	Description
ICollectionClient<ICsr>

ListSigningKeys()

Declaration

public ICollectionClient<IJsonWebKey> ListSigningKeys()

Returns

Type	Description
ICollectionClient<IJsonWebKey>

ListSocialAuthTokens(String)

Declaration

public ICollectionClient<ISocialAuthToken> ListSocialAuthTokens(string userId)

Parameters

Type	Name	Description
System.String	userId

Returns

Type	Description
ICollectionClient<ISocialAuthToken>

ListUsers()

Declaration

public ICollectionClient<IIdentityProviderApplicationUser> ListUsers()

Returns

Type	Description
ICollectionClient<IIdentityProviderApplicationUser>

UnlinkUserAsync(String, CancellationToken)

Declaration

public 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

Implements

IIdentityProvider

IResource