You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::UpdateUserPoolClientRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateUserPoolClientRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  user_pool_id: "UserPoolIdType", # required
  client_id: "ClientIdType", # required
  client_name: "ClientNameType",
  refresh_token_validity: 1,
  read_attributes: ["ClientPermissionType"],
  write_attributes: ["ClientPermissionType"],
  explicit_auth_flows: ["ADMIN_NO_SRP_AUTH"], # accepts ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, USER_PASSWORD_AUTH
  supported_identity_providers: ["ProviderNameType"],
  callback_urls: ["RedirectUrlType"],
  logout_urls: ["RedirectUrlType"],
  default_redirect_uri: "RedirectUrlType",
  allowed_o_auth_flows: ["code"], # accepts code, implicit, client_credentials
  allowed_o_auth_scopes: ["ScopeType"],
  allowed_o_auth_flows_user_pool_client: false,
  analytics_configuration: {
    application_id: "HexStringType", # required
    role_arn: "ArnType", # required
    external_id: "StringType", # required
    user_data_shared: false,
  },
}

Represents the request to update the user pool client.

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_o_auth_flowsArray<String>

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.

Returns:

  • (Array<String>)

    Set to code to initiate a code grant flow, which provides an authorization code as the response.

#allowed_o_auth_flows_user_pool_clientBoolean

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

Returns:

  • (Boolean)

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

#allowed_o_auth_scopesArray<String>

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

Returns:

  • (Array<String>)

    A list of allowed OAuth scopes.

#analytics_configurationTypes::AnalyticsConfigurationType

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

Returns:

#callback_urlsArray<String>

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.

Returns:

  • (Array<String>)

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

#client_idString

The ID of the client associated with the user pool.

Returns:

  • (String)

    The ID of the client associated with the user pool.

#client_nameString

The client name from the update user pool client request.

Returns:

  • (String)

    The client name from the update user pool client request.

#default_redirect_uriString

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.

Returns:

  • (String)

    The default redirect URI.

#explicit_auth_flowsArray<String>

Explicit authentication flows.

Returns:

  • (Array<String>)

    Explicit authentication flows.

#logout_urlsArray<String>

A list of allowed logout URLs for the identity providers.

Returns:

  • (Array<String>)

    A list of allowed logout URLs for the identity providers.

#read_attributesArray<String>

The read-only attributes of the user pool.

Returns:

  • (Array<String>)

    The read-only attributes of the user pool.

#refresh_token_validityInteger

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

Returns:

  • (Integer)

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

#supported_identity_providersArray<String>

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

Returns:

  • (Array<String>)

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

#user_pool_idString

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

Returns:

  • (String)

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

#write_attributesArray<String>

The writeable attributes of the user pool.

Returns:

  • (Array<String>)

    The writeable attributes of the user pool.