:doc:`WorkSpacesWeb <../../workspaces-web>` / Client / list_identity_providers

***********************
list_identity_providers
***********************



.. py:method:: WorkSpacesWeb.Client.list_identity_providers(**kwargs)

  

  Retrieves a list of identity providers for a specific web portal.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListIdentityProviders>`_  


  **Request Syntax**
  ::

    response = client.list_identity_providers(
        nextToken='string',
        maxResults=123,
        portalArn='string'
    )
    
  :type nextToken: string
  :param nextToken: 

    The pagination token used to retrieve the next page of results for this operation.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to be included in the next page.

    

  
  :type portalArn: string
  :param portalArn: **[REQUIRED]** 

    The ARN of the web portal.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'nextToken': 'string',
          'identityProviders': [
              {
                  'identityProviderArn': 'string',
                  'identityProviderName': 'string',
                  'identityProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

        The pagination token used to retrieve the next page of results for this operation.

        
      

      - **identityProviders** *(list) --* 

        The identity providers.

        
        

        - *(dict) --* 

          The summary of the identity provider.

          
          

          - **identityProviderArn** *(string) --* 

            The ARN of the identity provider.

            
          

          - **identityProviderName** *(string) --* 

            The identity provider name.

            
          

          - **identityProviderType** *(string) --* 

            The identity provider type.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.InternalServerException`

  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.ThrottlingException`

  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.ValidationException`

  