|
20 | 20 | @class BFTask;
|
21 | 21 |
|
22 | 22 | /**
|
23 |
| - * <fullname>Amazon Cognito</fullname><p>Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices andother untrusted environments. Amazon Cognito uniquely identifies a device and supplies the userwith a consistent identity over the lifetime of an application.</p><p>Using Amazon Cognito, you can enable authentication with one or more third-party identityproviders (Facebook, Google, or Login with Amazon), and you can also choose to supportunauthenticated access from your app. Cognito delivers a unique identifier for each userand acts as an OpenID token provider trusted by AWS Security Token Service (STS) to accesstemporary, limited-privilege AWS credentials.</p><p>To provide end-user credentials, first make an unsigned call to <a>GetId</a>. If the enduser is authenticated with one of the supported identity providers, set the <code>Logins</code> map with the identity provider token. <code>GetId</code> returns aunique identifier for the user.</p><p>Next, make an unsigned call to <a>GetOpenIdToken</a>, which returns the OpenID tokennecessary to call STS and retrieve AWS credentials. This call expects the same <code>Logins</code> map as the <code>GetId</code> call, as well as the <code>IdentityID</code> originally returned by <code>GetId</code>. The token returned by <code>GetOpenIdToken</code> can be passed to the STS operation <a href="http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html">AssumeRoleWithWebIdentity</a> to retrieve AWS credentials.</p> |
| 23 | + * <fullname>Amazon Cognito</fullname><p>Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.</p><p>Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.</p><p>To provide end-user credentials, first make an unsigned call to <a>GetId</a>. If the end user is authenticated with one of the supported identity providers, set the <code>Logins</code> map with the identity provider token. <code>GetId</code> returns a unique identifier for the user.</p><p>Next, make an unsigned call to <a>GetOpenIdToken</a>, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same <code>Logins</code> map as the <code>GetId</code> call, as well as the <code>IdentityID</code> originally returned by <code>GetId</code>. The token returned by <code>GetOpenIdToken</code> can be passed to the STS operation <a href="http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html">AssumeRoleWithWebIdentity</a> to retrieve AWS credentials.</p> |
24 | 24 | */
|
25 | 25 | @interface AWSCognitoIdentity : AWSService
|
26 | 26 |
|
|
31 | 31 | - (instancetype)initWithConfiguration:(AWSServiceConfiguration *)configuration;
|
32 | 32 |
|
33 | 33 | /**
|
34 |
| - * <p>Creates a new identity pool. The identity pool is a store of user identity information thatis specific to your AWS account. The limit on identity pools is 60 per account.</p> |
| 34 | + * <p>Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account.</p> |
35 | 35 | *
|
36 | 36 | * @param request A container for the necessary parameters to execute the CreateIdentityPool service method.
|
37 | 37 | *
|
|
43 | 43 | - (BFTask *)createIdentityPool:(AWSCognitoIdentityCreateIdentityPoolInput *)request;
|
44 | 44 |
|
45 | 45 | /**
|
46 |
| - * <p>Deletes a user pool. Once a pool is deleted, users will not be able to authenticate withthe pool.</p> |
| 46 | + * <p>Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.</p> |
47 | 47 | *
|
48 | 48 | * @param request A container for the necessary parameters to execute the DeleteIdentityPool service method.
|
49 | 49 | *
|
|
54 | 54 | - (BFTask *)deleteIdentityPool:(AWSCognitoIdentityDeleteIdentityPoolInput *)request;
|
55 | 55 |
|
56 | 56 | /**
|
57 |
| - * <p>Gets details about a particular identity pool, including the pool name, ID description,creation date, and current number of users.</p> |
| 57 | + * <p>Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.</p> |
58 | 58 | *
|
59 | 59 | * @param request A container for the necessary parameters to execute the DescribeIdentityPool service method.
|
60 | 60 | *
|
|
66 | 66 | - (BFTask *)describeIdentityPool:(AWSCognitoIdentityDescribeIdentityPoolInput *)request;
|
67 | 67 |
|
68 | 68 | /**
|
69 |
| - * <p>Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicitlinked account.</p> |
| 69 | + * <p>Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.</p> |
70 | 70 | *
|
71 | 71 | * @param request A container for the necessary parameters to execute the GetId service method.
|
72 | 72 | *
|
|
78 | 78 | - (BFTask *)getId:(AWSCognitoIdentityGetIdInput *)request;
|
79 | 79 |
|
80 | 80 | /**
|
81 |
| - * <p>Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by<a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple loginscreates an implicit link.</p><p>The OpenId token is valid for 15 minutes.</p> |
| 81 | + * <p>Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by <a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.</p><p>The OpenId token is valid for 15 minutes.</p> |
82 | 82 | *
|
83 | 83 | * @param request A container for the necessary parameters to execute the GetOpenIdToken service method.
|
84 | 84 | *
|
|
89 | 89 | */
|
90 | 90 | - (BFTask *)getOpenIdToken:(AWSCognitoIdentityGetOpenIdTokenInput *)request;
|
91 | 91 |
|
| 92 | +/** |
| 93 | + * <p>Registers (or retrieves) a Cognito <code>IdentityId</code> and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the <code>Logins</code> map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.</p><p>You can use <code>GetOpenIdTokenForDeveloperIdentity</code> to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the <code>IdentityId</code> should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing <code>IdentityId</code>. This API will create the identity in the specified <code>IdentityPoolId</code>.</p> |
| 94 | + * |
| 95 | + * @param request A container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity service method. |
| 96 | + * |
| 97 | + * @return An instance of BFTask. On successful execution, task.result will contain an instance of AWSCognitoIdentityGetOpenIdTokenForDeveloperIdentityResponse. On failed execution, task.error may contain an NSError with AWSCognitoIdentityErrorDomain domian and the following error code: AWSCognitoIdentityErrorInvalidParameter, AWSCognitoIdentityErrorResourceNotFound, AWSCognitoIdentityErrorNotAuthorized, AWSCognitoIdentityErrorResourceConflict, AWSCognitoIdentityErrorTooManyRequests, AWSCognitoIdentityErrorInternalError, AWSCognitoIdentityErrorDeveloperUserAlreadyRegistered. |
| 98 | + * |
| 99 | + * @see AWSCognitoIdentityGetOpenIdTokenForDeveloperIdentityInput |
| 100 | + * @see AWSCognitoIdentityGetOpenIdTokenForDeveloperIdentityResponse |
| 101 | + */ |
92 | 102 | - (BFTask *)getOpenIdTokenForDeveloperIdentity:(AWSCognitoIdentityGetOpenIdTokenForDeveloperIdentityInput *)request;
|
93 | 103 |
|
94 | 104 | /**
|
|
115 | 125 | */
|
116 | 126 | - (BFTask *)listIdentityPools:(AWSCognitoIdentityListIdentityPoolsInput *)request;
|
117 | 127 |
|
| 128 | +/** |
| 129 | + * <p>Retrieves the <code>IdentityID</code> associated with a <code>DeveloperUserIdentifier</code> or the list of <code>DeveloperUserIdentifier</code>s associated with an <code>IdentityId</code> for an existing identity. Either <code>IdentityID</code> or <code>DeveloperUserIdentifier</code> must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, <code>DeveloperUserIdentifier</code> will be matched against <code>IdentityID</code>. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a <code>ResourceConflictException</code> is thrown.</p> |
| 130 | + * |
| 131 | + * @param request A container for the necessary parameters to execute the LookupDeveloperIdentity service method. |
| 132 | + * |
| 133 | + * @return An instance of BFTask. On successful execution, task.result will contain an instance of AWSCognitoIdentityLookupDeveloperIdentityResponse. On failed execution, task.error may contain an NSError with AWSCognitoIdentityErrorDomain domian and the following error code: AWSCognitoIdentityErrorInvalidParameter, AWSCognitoIdentityErrorResourceNotFound, AWSCognitoIdentityErrorNotAuthorized, AWSCognitoIdentityErrorResourceConflict, AWSCognitoIdentityErrorTooManyRequests, AWSCognitoIdentityErrorInternalError. |
| 134 | + * |
| 135 | + * @see AWSCognitoIdentityLookupDeveloperIdentityInput |
| 136 | + * @see AWSCognitoIdentityLookupDeveloperIdentityResponse |
| 137 | + */ |
118 | 138 | - (BFTask *)lookupDeveloperIdentity:(AWSCognitoIdentityLookupDeveloperIdentityInput *)request;
|
119 | 139 |
|
| 140 | +/** |
| 141 | + * <p>Merges two users having different <code>IdentityId</code>s, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (<code>SourceUserIdentifier</code>) with the <code>IdentityId</code> of the <code>DestinationUserIdentifier</code>. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.</p> |
| 142 | + * |
| 143 | + * @param request A container for the necessary parameters to execute the MergeDeveloperIdentities service method. |
| 144 | + * |
| 145 | + * @return An instance of BFTask. On successful execution, task.result will contain an instance of AWSCognitoIdentityMergeDeveloperIdentitiesResponse. On failed execution, task.error may contain an NSError with AWSCognitoIdentityErrorDomain domian and the following error code: AWSCognitoIdentityErrorInvalidParameter, AWSCognitoIdentityErrorResourceNotFound, AWSCognitoIdentityErrorNotAuthorized, AWSCognitoIdentityErrorResourceConflict, AWSCognitoIdentityErrorTooManyRequests, AWSCognitoIdentityErrorInternalError. |
| 146 | + * |
| 147 | + * @see AWSCognitoIdentityMergeDeveloperIdentitiesInput |
| 148 | + * @see AWSCognitoIdentityMergeDeveloperIdentitiesResponse |
| 149 | + */ |
120 | 150 | - (BFTask *)mergeDeveloperIdentities:(AWSCognitoIdentityMergeDeveloperIdentitiesInput *)request;
|
121 | 151 |
|
| 152 | +/** |
| 153 | + * <p>Unlinks a <code>DeveloperUserIdentifier</code> from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.</p> |
| 154 | + * |
| 155 | + * @param request A container for the necessary parameters to execute the UnlinkDeveloperIdentity service method. |
| 156 | + * |
| 157 | + * @return An instance of BFTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSCognitoIdentityErrorDomain domian and the following error code: AWSCognitoIdentityErrorInvalidParameter, AWSCognitoIdentityErrorResourceNotFound, AWSCognitoIdentityErrorNotAuthorized, AWSCognitoIdentityErrorResourceConflict, AWSCognitoIdentityErrorTooManyRequests, AWSCognitoIdentityErrorInternalError. |
| 158 | + * |
| 159 | + * @see AWSCognitoIdentityUnlinkDeveloperIdentityInput |
| 160 | + */ |
122 | 161 | - (BFTask *)unlinkDeveloperIdentity:(AWSCognitoIdentityUnlinkDeveloperIdentityInput *)request;
|
123 | 162 |
|
124 | 163 | /**
|
125 |
| - * <p>Unlinks a federated identity from an existing account. Unlinked logins will be considerednew identities next time they are seen. Removing the last linked login will make thisidentity inaccessible.</p> |
| 164 | + * <p>Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.</p> |
126 | 165 | *
|
127 | 166 | * @param request A container for the necessary parameters to execute the UnlinkIdentity service method.
|
128 | 167 | *
|
|
0 commit comments