CalOohPay API Documentation - v2.1.0
    Preparing search index...

    Interface User

    Represents a PagerDuty user entity.

    This interface matches the structure of user objects returned by the PagerDuty API. It contains identifying information and URLs for a user who may be assigned to on-call shifts in a schedule.

    API Reference

    const user: User = {
      type: 'user_reference',
      id: 'PXXXXXX',
      summary: 'John Doe',
      self: 'https://api.pagerduty.com/users/PXXXXXX',
      html_url: 'https://yourcompany.pagerduty.com/users/PXXXXXX'
    };
    interface User {
        html_url?: string;
        id: string;
        self?: string;
        summary?: string;
        type: string;
    }
    Index

    Properties

    html_url? id self? summary? type

    Properties

    html_url?: string

    Optional web URL to view the user's profile in PagerDuty. Direct link to the user's page in the PagerDuty web interface.

    'https://yourcompany.pagerduty.com/users/PXXXXXX'
    id: string

    Unique identifier for the user in PagerDuty. Format: Starts with 'P' followed by alphanumeric characters.

    'PXXXXXX'
    self?: string

    Optional API URL to retrieve full user details. Can be used to fetch additional user information from PagerDuty.

    'https://api.pagerduty.com/users/PXXXXXX'
    summary?: string

    Optional display name or summary of the user. Usually the user's full name as configured in PagerDuty.

    'John Doe'
    type: string

    The type of PagerDuty object. Typically 'user' or 'user_reference' for user entities.

    Settings

    Member Visibility

    On This Page

    Properties