Package software.amazon.awssdk.services.ssooidc.model

Interface RegisterClientRequest.Builder

    • Method Detail

      • clientName

        RegisterClientRequest.Builder clientName​(String clientName)

        The friendly name of the client.

        Parameters:
        clientName - The friendly name of the client.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientType

        RegisterClientRequest.Builder clientType​(String clientType)

        The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.

        Parameters:
        clientType - The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scopes

        RegisterClientRequest.Builder scopes​(Collection<String> scopes)

        The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

        Parameters:
        scopes - The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scopes

        RegisterClientRequest.Builder scopes​(String... scopes)

        The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

        Parameters:
        scopes - The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • redirectUris

        RegisterClientRequest.Builder redirectUris​(Collection<String> redirectUris)

        The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.

        Parameters:
        redirectUris - The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • redirectUris

        RegisterClientRequest.Builder redirectUris​(String... redirectUris)

        The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.

        Parameters:
        redirectUris - The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • grantTypes

        RegisterClientRequest.Builder grantTypes​(Collection<String> grantTypes)

        The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client. Supports the following OAuth 2.0 grant types: Authorization Code, Device Code, and Refresh Token.

        * Authorization Code - authorization_code

        * Device Code - urn:ietf:params:oauth:grant-type:device_code

        * Refresh Token - refresh_token

        Parameters:
        grantTypes - The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client. Supports the following OAuth 2.0 grant types: Authorization Code, Device Code, and Refresh Token.

        * Authorization Code - authorization_code

        * Device Code - urn:ietf:params:oauth:grant-type:device_code

        * Refresh Token - refresh_token

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • grantTypes

        RegisterClientRequest.Builder grantTypes​(String... grantTypes)

        The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client. Supports the following OAuth 2.0 grant types: Authorization Code, Device Code, and Refresh Token.

        * Authorization Code - authorization_code

        * Device Code - urn:ietf:params:oauth:grant-type:device_code

        * Refresh Token - refresh_token

        Parameters:
        grantTypes - The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client. Supports the following OAuth 2.0 grant types: Authorization Code, Device Code, and Refresh Token.

        * Authorization Code - authorization_code

        * Device Code - urn:ietf:params:oauth:grant-type:device_code

        * Refresh Token - refresh_token

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • issuerUrl

        RegisterClientRequest.Builder issuerUrl​(String issuerUrl)

        The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client.

        Parameters:
        issuerUrl - The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • entitledApplicationArn

        RegisterClientRequest.Builder entitledApplicationArn​(String entitledApplicationArn)

        This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources. At authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource.

        Parameters:
        entitledApplicationArn - This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources. At authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.