:doc:`WickrAdminAPI <../../wickr>` / Client / register_oidc_config_test

*************************
register_oidc_config_test
*************************



.. py:method:: WickrAdminAPI.Client.register_oidc_config_test(**kwargs)

  

  Tests an OpenID Connect (OIDC) configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wickr-2024-02-01/RegisterOidcConfigTest>`_  


  **Request Syntax**
  ::

    response = client.register_oidc_config_test(
        networkId='string',
        extraAuthParams='string',
        issuer='string',
        scopes='string',
        certificate='string'
    )
    
  :type networkId: string
  :param networkId: **[REQUIRED]** 

    The ID of the Wickr network for which the OIDC configuration will be tested.

    

  
  :type extraAuthParams: string
  :param extraAuthParams: 

    Additional authentication parameters to include in the test (optional).

    

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

    The issuer URL of the OIDC provider to test.

    

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

    The OAuth scopes to test with the OIDC provider.

    

  
  :type certificate: string
  :param certificate: 

    The CA certificate for secure communication with the OIDC provider (optional).

    

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

    
    ::

      {
          'tokenEndpoint': 'string',
          'userinfoEndpoint': 'string',
          'responseTypesSupported': [
              'string',
          ],
          'scopesSupported': [
              'string',
          ],
          'issuer': 'string',
          'authorizationEndpoint': 'string',
          'endSessionEndpoint': 'string',
          'logoutEndpoint': 'string',
          'grantTypesSupported': [
              'string',
          ],
          'revocationEndpoint': 'string',
          'tokenEndpointAuthMethodsSupported': [
              'string',
          ],
          'microsoftMultiRefreshToken': True|False
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **tokenEndpoint** *(string) --* 

        The token endpoint URL discovered from the OIDC provider.

        
      

      - **userinfoEndpoint** *(string) --* 

        The user info endpoint URL discovered from the OIDC provider.

        
      

      - **responseTypesSupported** *(list) --* 

        The OAuth response types supported by the OIDC provider.

        
        

        - *(string) --* 
    
      

      - **scopesSupported** *(list) --* 

        The OAuth scopes supported by the OIDC provider.

        
        

        - *(string) --* 
    
      

      - **issuer** *(string) --* 

        The issuer URL confirmed by the OIDC provider.

        
      

      - **authorizationEndpoint** *(string) --* 

        The authorization endpoint URL discovered from the OIDC provider.

        
      

      - **endSessionEndpoint** *(string) --* 

        The end session endpoint URL for logging out users from the OIDC provider.

        
      

      - **logoutEndpoint** *(string) --* 

        The logout endpoint URL for terminating user sessions.

        
      

      - **grantTypesSupported** *(list) --* 

        The OAuth grant types supported by the OIDC provider.

        
        

        - *(string) --* 
    
      

      - **revocationEndpoint** *(string) --* 

        The token revocation endpoint URL for invalidating tokens.

        
      

      - **tokenEndpointAuthMethodsSupported** *(list) --* 

        The authentication methods supported by the token endpoint.

        
        

        - *(string) --* 
    
      

      - **microsoftMultiRefreshToken** *(boolean) --* 

        Indicates whether the provider supports Microsoft multi-refresh tokens.

        
  
  **Exceptions**
  
  *   :py:class:`WickrAdminAPI.Client.exceptions.ValidationError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.BadRequestError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.ResourceNotFoundError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.ForbiddenError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.UnauthorizedError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.InternalServerError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.RateLimitError`

  