Skip to content

Function: generateServerAuthorizationUrl() ​

ts
function generateServerAuthorizationUrl(params): string;

Defined in: src/core/oauthServer/helpers.ts:90

Build the URL to send the user to so they can grant access to a Data Center instance.

state is yours to generate and to verify when the callback comes back — it is what stops CSRF on the redirect.

The clientId and redirectUri are the ones an administrator registered as an incoming application link; a redirectUri that does not match the registration is rejected by the instance rather than by this function.

Parameters ​

ParameterType
params{ clientId: string; host: string; redirectUri: string; scopes: ServerOAuth2Scope[]; state: string; }
params.clientIdstring
params.hoststring
params.redirectUristring
params.scopesServerOAuth2Scope[]
params.statestring

Returns ​

string