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

************************
create_identity_provider
************************



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

  

  Creates an identity provider resource that is then associated with a web portal.

  

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


  **Request Syntax**
  ::

    response = client.create_identity_provider(
        portalArn='string',
        identityProviderName='string',
        identityProviderType='SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC',
        identityProviderDetails={
            'string': 'string'
        },
        clientToken='string',
        tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    )
    
  :type portalArn: string
  :param portalArn: **[REQUIRED]** 

    The ARN of the web portal.

    

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

    The identity provider name.

    

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

    The identity provider type.

    

  
  :type identityProviderDetails: dict
  :param identityProviderDetails: **[REQUIRED]** 

    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) --* 

      


  :type clientToken: string
  :param clientToken: 

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

     

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

    This field is autopopulated if not provided.

  
  :type tags: list
  :param tags: 

    The tags to add to the identity provider resource. A tag is a key-value pair.

    

  
    - *(dict) --* 

      The tag.

      

    
      - **Key** *(string) --* **[REQUIRED]** 

        The key of the tag.

        

      
      - **Value** *(string) --* **[REQUIRED]** 

        The value of the tag

        

      
    

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

    
    ::

      {
          'identityProviderArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The ARN of the identity provider.

        
  
  **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.ServiceQuotaExceededException`

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

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

  