|
AppAuth
|
AppAuth iOS SDK. More...
#import <Foundation/Foundation.h>Go to the source code of this file.
Variables | |
| NSString *const | OIDGeneralErrorDomain |
| The error domain for all NSErrors returned from the AppAuth library. | |
| NSString *const | OIDOAuthAuthorizationErrorDomain |
The error domain for OAuth specific errors on the authorization endpoint. @discussion This error domain is used when the server responds to an authorization request with an explicit OAuth error, as defined by RFC6749 Section 4.1.2.1. If the authorization response is invalid and not explicitly an error response, another error domain will be used. The error response parameter dictionary is available in the NSError.userInfo dictionary using the OIDOAuthErrorResponseErrorKey key. The NSError.code will be one of the OIDErrorCodeOAuthAuthorization enum values. More... | |
| NSString *const | OIDOAuthTokenErrorDomain |
The error domain for OAuth specific errors on the token endpoint. @discussion This error domain is used when the server responds with HTTP 400 and an OAuth error, as defined RFC6749 Section 5.2. If an HTTP 400 response does not parse as an OAuth error (i.e. no 'error' field is present or the JSON is invalid), another error domain will be used. The entire OAuth error response dictionary is available in the NSError.userInfo dictionary using the OIDOAuthErrorResponseErrorKey key. Unlike transient network errors, errors in this domain invalidate the authentication state, and either indicate a client error or require user interaction (i.e. reauthentication) to resolve. The NSError.code will be one of the OIDErrorCodeOAuthToken enum values. More... | |
| NSString *const | OIDOAuthRegistrationErrorDomain |
The error domain for dynamic client registration errors. @discussion This error domain is used when the server responds with HTTP 400 and an OAuth error, as defined in OpenID Connect Dynamic Client Registration 1.0 Section 3.3. If an HTTP 400 response does not parse as an OAuth error (i.e. no 'error' field is present or the JSON is invalid), another error domain will be used. The entire OAuth error response dictionary is available in the NSError.userInfo dictionary using the OIDOAuthErrorResponseErrorKey key. Unlike transient network errors, errors in this domain invalidate the authentication state, and indicates a client error. The NSError.code will be one of the OIDErrorCodeOAuthToken enum values. More... | |
| NSString *const | OIDResourceServerAuthorizationErrorDomain |
| The error domain for authorization errors encountered out of band on the resource server. | |
| NSString *const | OIDHTTPErrorDomain |
| An error domain representing received HTTP errors. | |
| NSString *const | OIDOAuthErrorResponseErrorKey |
| An error key for the original OAuth error response (if any). | |
| NSString *const | OIDOAuthErrorFieldError |
| The key of the 'error' response field in a RFC6749 Section 5.2 response. More... | |
| NSString *const | OIDOAuthErrorFieldErrorDescription |
| The key of the 'error_description' response field in a RFC6749 Section 5.2 response. More... | |
| NSString *const | OIDOAuthErrorFieldErrorURI |
| The key of the 'error_uri' response field in a RFC6749 Section 5.2 response. More... | |
| NSString *const | OIDOAuthExceptionInvalidAuthorizationFlow |
The exception text for the exception which occurs when a OIDExternalUserAgentSession receives a message after it has already completed. | |
| NSString *const | OIDOAuthExceptionInvalidTokenRequestNullRedirectURL |
| The text for the exception which occurs when a Token Request is constructed with a null redirectURL for a grant_type that requires a nonnull Redirect. | |
AppAuth iOS SDK.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
| enum OIDErrorCode |
The various error codes returned from the AppAuth library.
| enum OIDErrorCodeOAuth |
Enum of all possible OAuth error codes as defined by RFC6749 @discussion Used by OIDErrorCodeOAuthAuthorization and OIDErrorCodeOAuthToken which define endpoint-specific subsets of OAuth codes. Those enum types are down-castable to this one.
| Enumerator | |
|---|---|
| OIDErrorCodeOAuthInvalidRequest |
|
| OIDErrorCodeOAuthUnauthorizedClient |
|
| OIDErrorCodeOAuthAccessDenied |
|
| OIDErrorCodeOAuthUnsupportedResponseType |
|
| OIDErrorCodeOAuthInvalidScope |
|
| OIDErrorCodeOAuthServerError |
|
| OIDErrorCodeOAuthTemporarilyUnavailable |
|
| OIDErrorCodeOAuthInvalidClient |
|
| OIDErrorCodeOAuthInvalidGrant |
|
| OIDErrorCodeOAuthUnsupportedGrantType |
|
| OIDErrorCodeOAuthInvalidRedirectURI |
|
| OIDErrorCodeOAuthInvalidClientMetadata |
|
| OIDErrorCodeOAuthClientError | An authorization error occurring on the client rather than the server. For example, due to a state mismatch or misconfiguration. Should be treated as an unrecoverable authorization error. |
| OIDErrorCodeOAuthOther | An OAuth error not known to this library @discussion Indicates an OAuth error as per RFC6749, but the error code was not in our list. It could be a custom error code, or one from an OAuth extension. See the "error" key of the |
The error codes for the OIDOAuthAuthorizationErrorDomain error domain.
| Enumerator | |
|---|---|
| OIDErrorCodeOAuthAuthorizationInvalidRequest |
|
| OIDErrorCodeOAuthAuthorizationUnauthorizedClient |
|
| OIDErrorCodeOAuthAuthorizationAccessDenied |
|
| OIDErrorCodeOAuthAuthorizationUnsupportedResponseType |
|
| OIDErrorCodeOAuthAuthorizationAuthorizationInvalidScope | Indicates a network error or server error occurred.
|
| OIDErrorCodeOAuthAuthorizationServerError | Indicates a server error occurred.
|
| OIDErrorCodeOAuthAuthorizationTemporarilyUnavailable |
|
| OIDErrorCodeOAuthAuthorizationClientError | An authorization error occurring on the client rather than the server. For example, due to a state mismatch or client misconfiguration. Should be treated as an unrecoverable authorization error. |
| OIDErrorCodeOAuthAuthorizationOther | An authorization OAuth error not known to this library @discussion this indicates an OAuth error as per RFC6749, but the error code was not in our list. It could be a custom error code, or one from an OAuth extension. See the "error" key of the |
The error codes for the OIDOAuthRegistrationErrorDomain error domain.
| Enumerator | |
|---|---|
| OIDErrorCodeOAuthRegistrationInvalidRequest |
|
| OIDErrorCodeOAuthRegistrationInvalidRedirectURI |
|
| OIDErrorCodeOAuthRegistrationInvalidClientMetadata |
|
| OIDErrorCodeOAuthRegistrationClientError | An unrecoverable token error occurring on the client rather than the server. |
| OIDErrorCodeOAuthRegistrationOther | A registration endpoint OAuth error not known to this library @discussion this indicates an OAuth error, but the error code was not in our list. It could be a custom error code, or one from an OAuth extension. See the "error" key of the |
The error codes for the OIDOAuthTokenErrorDomain error domain.
| Enumerator | |
|---|---|
| OIDErrorCodeOAuthTokenInvalidRequest |
|
| OIDErrorCodeOAuthTokenInvalidClient |
|
| OIDErrorCodeOAuthTokenInvalidGrant |
|
| OIDErrorCodeOAuthTokenUnauthorizedClient |
|
| OIDErrorCodeOAuthTokenUnsupportedGrantType |
|
| OIDErrorCodeOAuthTokenInvalidScope |
|
| OIDErrorCodeOAuthTokenClientError | An unrecoverable token error occurring on the client rather than the server. |
| OIDErrorCodeOAuthTokenOther | A token endpoint OAuth error not known to this library @discussion this indicates an OAuth error as per RFC6749, but the error code was not in our list. It could be a custom error code, or one from an OAuth extension. See the "error" key of the |
| NSString* const OIDOAuthAuthorizationErrorDomain |
The error domain for OAuth specific errors on the authorization endpoint. @discussion This error domain is used when the server responds to an authorization request with an explicit OAuth error, as defined by RFC6749 Section 4.1.2.1. If the authorization response is invalid and not explicitly an error response, another error domain will be used. The error response parameter dictionary is available in the NSError.userInfo dictionary using the OIDOAuthErrorResponseErrorKey key. The NSError.code will be one of the OIDErrorCodeOAuthAuthorization enum values.
| NSString* const OIDOAuthErrorFieldError |
The key of the 'error' response field in a RFC6749 Section 5.2 response.
| NSString* const OIDOAuthErrorFieldErrorDescription |
The key of the 'error_description' response field in a RFC6749 Section 5.2 response.
| NSString* const OIDOAuthErrorFieldErrorURI |
The key of the 'error_uri' response field in a RFC6749 Section 5.2 response.
| NSString* const OIDOAuthRegistrationErrorDomain |
The error domain for dynamic client registration errors. @discussion This error domain is used when the server responds with HTTP 400 and an OAuth error, as defined in OpenID Connect Dynamic Client Registration 1.0 Section 3.3. If an HTTP 400 response does not parse as an OAuth error (i.e. no 'error' field is present or the JSON is invalid), another error domain will be used. The entire OAuth error response dictionary is available in the NSError.userInfo dictionary using the OIDOAuthErrorResponseErrorKey key. Unlike transient network errors, errors in this domain invalidate the authentication state, and indicates a client error. The NSError.code will be one of the OIDErrorCodeOAuthToken enum values.
| NSString* const OIDOAuthTokenErrorDomain |
The error domain for OAuth specific errors on the token endpoint. @discussion This error domain is used when the server responds with HTTP 400 and an OAuth error, as defined RFC6749 Section 5.2. If an HTTP 400 response does not parse as an OAuth error (i.e. no 'error' field is present or the JSON is invalid), another error domain will be used. The entire OAuth error response dictionary is available in the NSError.userInfo dictionary using the OIDOAuthErrorResponseErrorKey key. Unlike transient network errors, errors in this domain invalidate the authentication state, and either indicate a client error or require user interaction (i.e. reauthentication) to resolve. The NSError.code will be one of the OIDErrorCodeOAuthToken enum values.
1.8.16