AWSCognitoIdentityProviderUpdateUserPoolClientRequest Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSCognitoIdentityProviderModel.h
AWSCognitoIdentityProviderModel.m

Overview

Represents the request to update the user pool client.

Required parameters: [UserPoolId, ClientId]

  allowedOAuthFlows

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

@property (nonatomic, strong) NSArray<NSString*> *allowedOAuthFlows

Declared In

AWSCognitoIdentityProviderModel.h

  allowedOAuthFlowsUserPoolClient

Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

@property (nonatomic, strong) NSNumber *allowedOAuthFlowsUserPoolClient

Declared In

AWSCognitoIdentityProviderModel.h

  allowedOAuthScopes

A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".

@property (nonatomic, strong) NSArray<NSString*> *allowedOAuthScopes

Declared In

AWSCognitoIdentityProviderModel.h

  analyticsConfiguration

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

@property (nonatomic, strong) AWSCognitoIdentityProviderAnalyticsConfigurationType *analyticsConfiguration

Declared In

AWSCognitoIdentityProviderModel.h

  callbackURLs

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

@property (nonatomic, strong) NSArray<NSString*> *callbackURLs

Declared In

AWSCognitoIdentityProviderModel.h

  clientId

The ID of the client associated with the user pool.

@property (nonatomic, strong) NSString *clientId

Declared In

AWSCognitoIdentityProviderModel.h

  clientName

The client name from the update user pool client request.

@property (nonatomic, strong) NSString *clientName

Declared In

AWSCognitoIdentityProviderModel.h

  defaultRedirectURI

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

@property (nonatomic, strong) NSString *defaultRedirectURI

Declared In

AWSCognitoIdentityProviderModel.h

  explicitAuthFlows

Explicit authentication flows.

@property (nonatomic, strong) NSArray<NSString*> *explicitAuthFlows

Declared In

AWSCognitoIdentityProviderModel.h

  logoutURLs

A list of allowed logout URLs for the identity providers.

@property (nonatomic, strong) NSArray<NSString*> *logoutURLs

Declared In

AWSCognitoIdentityProviderModel.h

  readAttributes

The read-only attributes of the user pool.

@property (nonatomic, strong) NSArray<NSString*> *readAttributes

Declared In

AWSCognitoIdentityProviderModel.h

  refreshTokenValidity

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

@property (nonatomic, strong) NSNumber *refreshTokenValidity

Declared In

AWSCognitoIdentityProviderModel.h

  supportedIdentityProviders

A list of provider names for the identity providers that are supported on this client.

@property (nonatomic, strong) NSArray<NSString*> *supportedIdentityProviders

Declared In

AWSCognitoIdentityProviderModel.h

  userPoolId

The user pool ID for the user pool where you want to update the user pool client.

@property (nonatomic, strong) NSString *userPoolId

Declared In

AWSCognitoIdentityProviderModel.h

  writeAttributes

The writeable attributes of the user pool.

@property (nonatomic, strong) NSArray<NSString*> *writeAttributes

Declared In

AWSCognitoIdentityProviderModel.h