Class OktaApiException

An exception wrapping an error returned by the Okta API.

Inheritance

System.Object

System.Exception

OktaException

OktaApiException

Implements

System.Runtime.Serialization.ISerializable

Inherited Members

System.Exception.GetBaseException()

System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)

System.Exception.GetType()

System.Exception.ToString()

System.Exception.Data

System.Exception.HelpLink

System.Exception.HResult

System.Exception.InnerException

System.Exception.Message

System.Exception.Source

System.Exception.StackTrace

System.Exception.TargetSite

System.Exception.SerializeObjectState

System.Object.Equals(System.Object)

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

System.Object.GetHashCode()

System.Object.MemberwiseClone()

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

Namespace: Okta.Sdk

Assembly: Okta.Sdk.dll

Syntax

public class OktaApiException : OktaException, ISerializable

Constructors

OktaApiException(Int32, IApiError)

Initializes a new instance of the OktaApiException class.

Declaration

public OktaApiException(int statusCode, IApiError error)

Parameters

Type	Name	Description
System.Int32	statusCode	The HTTP status code.
IApiError	error	The error data.

Properties

Error

Gets the error object returned by the Okta API.

Declaration

public IApiError Error { get; }

Property Value

Type	Description
IApiError	The error object returned by the Okta API.

ErrorCauses

Gets the list of error causes from the Error object.

Declaration

public IEnumerable<IApiErrorCause> ErrorCauses { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<IApiErrorCause>	The list of error causes.

ErrorCode

Gets the error code from the Error object.

Declaration

public string ErrorCode { get; }

Property Value

Type	Description
System.String	The error code.

ErrorId

Gets the error ID from the Error object.

Declaration

public string ErrorId { get; }

Property Value

Type	Description
System.String	The error ID.

ErrorLink

Gets the error link from the Error object.

Declaration

public string ErrorLink { get; }

Property Value

Type	Description
System.String	The error link.

ErrorSummary

Gets the error summary from the Error object.

Declaration

public string ErrorSummary { get; }

Property Value

Type	Description
System.String	The error summary.

StatusCode

Gets the HTTP status code.

Declaration

public int StatusCode { get; }

Property Value

Type	Description
System.Int32	The HTTP status code.

Implements

System.Runtime.Serialization.ISerializable