Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444175204.9 KB

Registers and saves an OpenID Connect (OIDC) configuration for a Wickr network, enabling Single Sign-On (SSO) authentication through an identity provider.

post/networks/{networkId}/oidc/save

Path parameters

networkIdstring required

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

Request body

companyIdstring required

Custom identifier your end users will use to sign in with SSO.

customUsernamestring
<p>A custom field mapping to extract the username from the OIDC token (optional). </p> <note> <p>The customUsername is only required if you use something other than email as the username field.</p> </note>
extraAuthParamsstring

Additional authentication parameters to include in the OIDC flow (optional).

issuerstring required

The issuer URL of the OIDC provider (e.g., 'https://login.example.com').

scopesstring required

The OAuth scopes to request from the OIDC provider (e.g., 'openid profile email').

secretstring password

The client secret for authenticating with the OIDC provider (optional).

ssoTokenBufferMinutesinteger

The buffer time in minutes before the SSO token expires to refresh it (optional).

userIdstring

Unique identifier provided by your identity provider to authenticate the access request. Also referred to as clientID.

Response

Success

applicationNamestring

The name of the registered OIDC application.

clientIdstring

The OAuth client ID assigned to the application.

companyIdstring required

Custom identifier your end users will use to sign in with SSO.

scopesstring required

The OAuth scopes configured for the application.

issuerstring required

The issuer URL of the OIDC provider.

clientSecretstring password

The OAuth client secret for the application.

secretstring password

The client secret for authenticating with the OIDC provider.

redirectUrlstring

The redirect URL configured for the OAuth flow.

userIdstring

The claim field being used as the user identifier.

customUsernamestring

The custom field mapping used for extracting the username.

caCertificatestring

The CA certificate used for secure communication with the OIDC provider.

applicationIdinteger

The unique identifier for the registered OIDC application.

ssoTokenBufferMinutesinteger

The buffer time in minutes before the SSO token expires.

extraAuthParamsstring

The additional authentication parameters configured for the OIDC flow.