getAuthorizationUrl()

function getAuthorizationUrl(__namedParameters: {
  baseUrl?: string;
  clientId: string;
  permissions: readonly (
     | "task:add"
     | "data:read"
     | "data:read_write"
     | "data:delete"
     | "project:delete"
    | "backups:read")[];
  state: string;
}): string;

Generates the authorization URL for the OAuth2 flow.

The clientId can be either a traditional client ID string (e.g. from registerClient) or an HTTPS URL pointing to a client metadata document, as defined in RFC draft-ietf-oauth-client-id-metadata-document.

Parameters

Parameter	Type
__namedParameters	{ baseUrl?: string; clientId: string; permissions: readonly ( | "task:add" | "data:read" | "data:read_write" | "data:delete" | "project:delete" | "backups:read")[]; state: string; }
__namedParameters.baseUrl?	string
__namedParameters.clientId	string
__namedParameters.permissions	readonly ( | "task:add" | "data:read" | "data:read_write" | "data:delete" | "project:delete" | "backups:read")[]
__namedParameters.state	string

Returns

string

The full authorization URL to redirect users to

Example

const url = getAuthorizationUrl({
  clientId: 'your-client-id',
  permissions: ['data:read', 'task:add'],
  state,
})
// Redirect user to url

See

https://developer.todoist.com/api/v1/#tag/Authorization/OAuth