v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Users

Regenerate a user's calendar feed URL key

Regenerate the private URL key used to construct a user's personal iCal calendar feed URLs (http_cal_url and web_cal_url). The old key is immediately invalidated; callers should update any stored feed subscriptions with the new key.

A user may only regenerate their own key. Account admins may regenerate on behalf of any user.

The calendar feed URLs act as bearer credentials: anyone with the URL can read that user's on-call calendar without further authentication. Rotate the key here whenever a URL may have been exposed (for example, if it was shared outside the intended audience or if an admin with can_update_user retrieved it via GET /users/{id}?include[]=calendar_urls).

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the API Concepts Document

Scoped OAuth requires: users.write

post/users/{id}/regenerate_private_url_key

Path parameters

idstring required

The ID of the resource.

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Response

The user's new private URL key.

private_url_keystring required

The newly generated private URL key for calendar feed URLs.