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

*********************
get_identity_provider
*********************



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

  

  Gets the identity provider.

  

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


  **Request Syntax**
  ::

    response = client.get_identity_provider(
        identityProviderArn='string'
    )
    
  :type identityProviderArn: string
  :param identityProviderArn: **[REQUIRED]** 

    The ARN of the identity provider.

    

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

    
    ::

      {
          'identityProvider': {
              'identityProviderArn': 'string',
              'identityProviderName': 'string',
              'identityProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC',
              'identityProviderDetails': {
                  'string': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **identityProvider** *(dict) --* 

        The identity provider.

        
        

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

          The ARN of the identity provider.

          
        

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

          The identity provider name.

          
        

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

          The identity provider type.

          
        

        - **identityProviderDetails** *(dict) --* 

          The identity provider details. The following list describes the provider detail keys for each identity provider type.

           

          
          * For Google and Login with Amazon: 

            
            * ``client_id``
             
            * ``client_secret``
             
            * ``authorize_scopes``
            

          
           
          * For Facebook: 

            
            * ``client_id``
             
            * ``client_secret``
             
            * ``authorize_scopes``
             
            * ``api_version``
            

          
           
          * For Sign in with Apple: 

            
            * ``client_id``
             
            * ``team_id``
             
            * ``key_id``
             
            * ``private_key``
             
            * ``authorize_scopes``
            

          
           
          * For OIDC providers: 

            
            * ``client_id``
             
            * ``client_secret``
             
            * ``attributes_request_method``
             
            * ``oidc_issuer``
             
            * ``authorize_scopes``
             
            * ``authorize_url`` *if not available from discovery URL specified by oidc_issuer key*
             
            * ``token_url`` *if not available from discovery URL specified by oidc_issuer key*
             
            * ``attributes_url`` *if not available from discovery URL specified by oidc_issuer key*
             
            * ``jwks_uri`` *if not available from discovery URL specified by oidc_issuer key*
            

          
           
          * For SAML providers: 

            
            * ``MetadataFile`` OR ``MetadataURL``
             
            * ``IDPSignout`` (boolean) *optional*
             
            * ``IDPInit`` (boolean) *optional*
             
            * ``RequestSigningAlgorithm`` (string) *optional* - Only accepts ``rsa-sha256``
             
            * ``EncryptedResponses`` (boolean) *optional*
            

          
          

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
    
  
  **Exceptions**
  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.InternalServerException`

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

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

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

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

  