WickrAdminAPI / Client / register_oidc_config_test

register_oidc_config_test

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

Request Syntax

response = client.register_oidc_config_test(
    networkId='string',
    extraAuthParams='string',
    issuer='string',
    scopes='string',
    certificate='string'
)
Parameters:

  • networkId (string) –

    [REQUIRED]

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

  • extraAuthParams (string) – Additional authentication parameters to include in the test (optional).

  • issuer (string) –

    [REQUIRED]

    The issuer URL of the OIDC provider to test.

  • scopes (string) –

    [REQUIRED]

    The OAuth scopes to test with the OIDC provider.

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

Return type:

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

  • WickrAdminAPI.Client.exceptions.ValidationError

  • WickrAdminAPI.Client.exceptions.BadRequestError

  • WickrAdminAPI.Client.exceptions.ResourceNotFoundError

  • WickrAdminAPI.Client.exceptions.ForbiddenError

  • WickrAdminAPI.Client.exceptions.UnauthorizedError

  • WickrAdminAPI.Client.exceptions.InternalServerError

  • WickrAdminAPI.Client.exceptions.RateLimitError