data
\n[object]
An array of downtimes.
attributes
\nobject
Downtime details.
canceled
\ndate-time
Time that the downtime was canceled.
created
\ndate-time
Creation time of the downtime.
display_timezone
\nstring
The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.
default: UTC
message
\nstring
A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.
modified
\ndate-time
Time that the downtime was last modified.
monitor_identifier
\n<oneOf>
Monitor identifier for the downtime.
Option 1
\nobject
Object of the monitor identifier.
monitor_id [required]
\nint64
ID of the monitor to prevent notifications.
Option 2
\nobject
Object of the monitor tags.
monitor_tags [required]
\n[string]
A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.
mute_first_recovery_notification
\nboolean
If the first recovery notification during a downtime should be muted.
notify_end_states
\n[string]
States that will trigger a monitor notification when the notify_end_types action occurs.
notify_end_types
\n[string]
Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.
schedule
\n<oneOf>
The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.
Option 1
\nobject
A recurring downtime schedule definition.
current_downtime
\nobject
The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.
end
\ndate-time
The end of the current downtime.
start
\ndate-time
The start of the current downtime.
recurrences [required]
\n[object]
A list of downtime recurrences.
duration
\nstring
The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.
rrule
\nstring
The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.
Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.
start
\nstring
ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.
timezone
\nstring
The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.
default: UTC
Option 2
\nobject
A one-time downtime definition.
end
\ndate-time
ISO-8601 Datetime to end the downtime.
start [required]
\ndate-time
ISO-8601 Datetime to start the downtime.
scope
\nstring
The scope to which the downtime applies. Must follow the common search syntax.
status
\nenum
The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled
id
\nstring
The downtime ID.
relationships
\nobject
All relationships associated with downtime.
created_by
\nobject
The user who created the downtime.
data
\nobject
Data for the user who created the downtime.
id
\nstring
User ID of the downtime creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
monitor
\nobject
The monitor identified by the downtime.
data
\nobject
Data for the monitor.
id
\nstring
Monitor ID of the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
type
\nenum
Downtime resource type. \nAllowed enum values: downtime
default: downtime
included
\n[ <oneOf>]
Array of objects related to the downtimes.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Information about the monitor identified by the downtime.
attributes
\nobject
Attributes of the monitor identified by the downtime.
name
\nstring
The name of the monitor identified by the downtime.
id
\nint64
ID of the monitor identified by the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
meta
\nobject
Pagination metadata returned by the API.
page
\nobject
Object containing the total filtered count.
total_filtered_count
\nint64
Total count of elements matched by the filter.
data
\n[object]
An array of downtimes.
attributes
\nobject
Downtime details.
canceled
\ndate-time
Time that the downtime was canceled.
created
\ndate-time
Creation time of the downtime.
display_timezone
\nstring
The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.
default: UTC
message
\nstring
A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.
modified
\ndate-time
Time that the downtime was last modified.
monitor_identifier
\n<oneOf>
Monitor identifier for the downtime.
Option 1
\nobject
Object of the monitor identifier.
monitor_id [required]
\nint64
ID of the monitor to prevent notifications.
Option 2
\nobject
Object of the monitor tags.
monitor_tags [required]
\n[string]
A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.
mute_first_recovery_notification
\nboolean
If the first recovery notification during a downtime should be muted.
notify_end_states
\n[string]
States that will trigger a monitor notification when the notify_end_types action occurs.
notify_end_types
\n[string]
Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.
schedule
\n<oneOf>
The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.
Option 1
\nobject
A recurring downtime schedule definition.
current_downtime
\nobject
The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.
end
\ndate-time
The end of the current downtime.
start
\ndate-time
The start of the current downtime.
recurrences [required]
\n[object]
A list of downtime recurrences.
duration
\nstring
The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.
rrule
\nstring
The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.
Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.
start
\nstring
ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.
timezone
\nstring
The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.
default: UTC
Option 2
\nobject
A one-time downtime definition.
end
\ndate-time
ISO-8601 Datetime to end the downtime.
start [required]
\ndate-time
ISO-8601 Datetime to start the downtime.
scope
\nstring
The scope to which the downtime applies. Must follow the common search syntax.
status
\nenum
The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled
id
\nstring
The downtime ID.
relationships
\nobject
All relationships associated with downtime.
created_by
\nobject
The user who created the downtime.
data
\nobject
Data for the user who created the downtime.
id
\nstring
User ID of the downtime creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
monitor
\nobject
The monitor identified by the downtime.
data
\nobject
Data for the monitor.
id
\nstring
Monitor ID of the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
type
\nenum
Downtime resource type. \nAllowed enum values: downtime
default: downtime
included
\n[ <oneOf>]
Array of objects related to the downtimes.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Information about the monitor identified by the downtime.
attributes
\nobject
Attributes of the monitor identified by the downtime.
name
\nstring
The name of the monitor identified by the downtime.
id
\nint64
ID of the monitor identified by the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
meta
\nobject
Pagination metadata returned by the API.
page
\nobject
Object containing the total filtered count.
total_filtered_count
\nint64
Total count of elements matched by the filter.
data
\nobject
Downtime data.
attributes
\nobject
Downtime details.
canceled
\ndate-time
Time that the downtime was canceled.
created
\ndate-time
Creation time of the downtime.
display_timezone
\nstring
The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.
default: UTC
message
\nstring
A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.
modified
\ndate-time
Time that the downtime was last modified.
monitor_identifier
\n<oneOf>
Monitor identifier for the downtime.
Option 1
\nobject
Object of the monitor identifier.
monitor_id [required]
\nint64
ID of the monitor to prevent notifications.
Option 2
\nobject
Object of the monitor tags.
monitor_tags [required]
\n[string]
A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.
mute_first_recovery_notification
\nboolean
If the first recovery notification during a downtime should be muted.
notify_end_states
\n[string]
States that will trigger a monitor notification when the notify_end_types action occurs.
notify_end_types
\n[string]
Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.
schedule
\n<oneOf>
The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.
Option 1
\nobject
A recurring downtime schedule definition.
current_downtime
\nobject
The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.
end
\ndate-time
The end of the current downtime.
start
\ndate-time
The start of the current downtime.
recurrences [required]
\n[object]
A list of downtime recurrences.
duration
\nstring
The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.
rrule
\nstring
The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.
Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.
start
\nstring
ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.
timezone
\nstring
The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.
default: UTC
Option 2
\nobject
A one-time downtime definition.
end
\ndate-time
ISO-8601 Datetime to end the downtime.
start [required]
\ndate-time
ISO-8601 Datetime to start the downtime.
scope
\nstring
The scope to which the downtime applies. Must follow the common search syntax.
status
\nenum
The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled
id
\nstring
The downtime ID.
relationships
\nobject
All relationships associated with downtime.
created_by
\nobject
The user who created the downtime.
data
\nobject
Data for the user who created the downtime.
id
\nstring
User ID of the downtime creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
monitor
\nobject
The monitor identified by the downtime.
data
\nobject
Data for the monitor.
id
\nstring
Monitor ID of the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
type
\nenum
Downtime resource type. \nAllowed enum values: downtime
default: downtime
included
\n[ <oneOf>]
Array of objects related to the downtime that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Information about the monitor identified by the downtime.
attributes
\nobject
Attributes of the monitor identified by the downtime.
name
\nstring
The name of the monitor identified by the downtime.
id
\nint64
ID of the monitor identified by the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
data
\nobject
Downtime data.
attributes
\nobject
Downtime details.
canceled
\ndate-time
Time that the downtime was canceled.
created
\ndate-time
Creation time of the downtime.
display_timezone
\nstring
The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.
default: UTC
message
\nstring
A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.
modified
\ndate-time
Time that the downtime was last modified.
monitor_identifier
\n<oneOf>
Monitor identifier for the downtime.
Option 1
\nobject
Object of the monitor identifier.
monitor_id [required]
\nint64
ID of the monitor to prevent notifications.
Option 2
\nobject
Object of the monitor tags.
monitor_tags [required]
\n[string]
A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.
mute_first_recovery_notification
\nboolean
If the first recovery notification during a downtime should be muted.
notify_end_states
\n[string]
States that will trigger a monitor notification when the notify_end_types action occurs.
notify_end_types
\n[string]
Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.
schedule
\n<oneOf>
The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.
Option 1
\nobject
A recurring downtime schedule definition.
current_downtime
\nobject
The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.
end
\ndate-time
The end of the current downtime.
start
\ndate-time
The start of the current downtime.
recurrences [required]
\n[object]
A list of downtime recurrences.
duration
\nstring
The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.
rrule
\nstring
The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.
Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.
start
\nstring
ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.
timezone
\nstring
The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.
default: UTC
Option 2
\nobject
A one-time downtime definition.
end
\ndate-time
ISO-8601 Datetime to end the downtime.
start [required]
\ndate-time
ISO-8601 Datetime to start the downtime.
scope
\nstring
The scope to which the downtime applies. Must follow the common search syntax.
status
\nenum
The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled
id
\nstring
The downtime ID.
relationships
\nobject
All relationships associated with downtime.
created_by
\nobject
The user who created the downtime.
data
\nobject
Data for the user who created the downtime.
id
\nstring
User ID of the downtime creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
monitor
\nobject
The monitor identified by the downtime.
data
\nobject
Data for the monitor.
id
\nstring
Monitor ID of the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
type
\nenum
Downtime resource type. \nAllowed enum values: downtime
default: downtime
included
\n[ <oneOf>]
Array of objects related to the downtime that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Information about the monitor identified by the downtime.
attributes
\nobject
Attributes of the monitor identified by the downtime.
name
\nstring
The name of the monitor identified by the downtime.
id
\nint64
ID of the monitor identified by the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
data
\nobject
Downtime data.
attributes
\nobject
Downtime details.
canceled
\ndate-time
Time that the downtime was canceled.
created
\ndate-time
Creation time of the downtime.
display_timezone
\nstring
The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.
default: UTC
message
\nstring
A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.
modified
\ndate-time
Time that the downtime was last modified.
monitor_identifier
\n<oneOf>
Monitor identifier for the downtime.
Option 1
\nobject
Object of the monitor identifier.
monitor_id [required]
\nint64
ID of the monitor to prevent notifications.
Option 2
\nobject
Object of the monitor tags.
monitor_tags [required]
\n[string]
A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.
mute_first_recovery_notification
\nboolean
If the first recovery notification during a downtime should be muted.
notify_end_states
\n[string]
States that will trigger a monitor notification when the notify_end_types action occurs.
notify_end_types
\n[string]
Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.
schedule
\n<oneOf>
The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.
Option 1
\nobject
A recurring downtime schedule definition.
current_downtime
\nobject
The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.
end
\ndate-time
The end of the current downtime.
start
\ndate-time
The start of the current downtime.
recurrences [required]
\n[object]
A list of downtime recurrences.
duration
\nstring
The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.
rrule
\nstring
The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.
Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.
start
\nstring
ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.
timezone
\nstring
The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.
default: UTC
Option 2
\nobject
A one-time downtime definition.
end
\ndate-time
ISO-8601 Datetime to end the downtime.
start [required]
\ndate-time
ISO-8601 Datetime to start the downtime.
scope
\nstring
The scope to which the downtime applies. Must follow the common search syntax.
status
\nenum
The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled
id
\nstring
The downtime ID.
relationships
\nobject
All relationships associated with downtime.
created_by
\nobject
The user who created the downtime.
data
\nobject
Data for the user who created the downtime.
id
\nstring
User ID of the downtime creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
monitor
\nobject
The monitor identified by the downtime.
data
\nobject
Data for the monitor.
id
\nstring
Monitor ID of the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
type
\nenum
Downtime resource type. \nAllowed enum values: downtime
default: downtime
included
\n[ <oneOf>]
Array of objects related to the downtime that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Information about the monitor identified by the downtime.
attributes
\nobject
Attributes of the monitor identified by the downtime.
name
\nstring
The name of the monitor identified by the downtime.
id
\nint64
ID of the monitor identified by the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
data
\nobject
Downtime data.
attributes
\nobject
Downtime details.
canceled
\ndate-time
Time that the downtime was canceled.
created
\ndate-time
Creation time of the downtime.
display_timezone
\nstring
The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.
default: UTC
message
\nstring
A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.
modified
\ndate-time
Time that the downtime was last modified.
monitor_identifier
\n<oneOf>
Monitor identifier for the downtime.
Option 1
\nobject
Object of the monitor identifier.
monitor_id [required]
\nint64
ID of the monitor to prevent notifications.
Option 2
\nobject
Object of the monitor tags.
monitor_tags [required]
\n[string]
A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.
mute_first_recovery_notification
\nboolean
If the first recovery notification during a downtime should be muted.
notify_end_states
\n[string]
States that will trigger a monitor notification when the notify_end_types action occurs.
notify_end_types
\n[string]
Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.
schedule
\n<oneOf>
The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.
Option 1
\nobject
A recurring downtime schedule definition.
current_downtime
\nobject
The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.
end
\ndate-time
The end of the current downtime.
start
\ndate-time
The start of the current downtime.
recurrences [required]
\n[object]
A list of downtime recurrences.
duration
\nstring
The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.
rrule
\nstring
The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.
Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.
start
\nstring
ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.
timezone
\nstring
The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.
default: UTC
Option 2
\nobject
A one-time downtime definition.
end
\ndate-time
ISO-8601 Datetime to end the downtime.
start [required]
\ndate-time
ISO-8601 Datetime to start the downtime.
scope
\nstring
The scope to which the downtime applies. Must follow the common search syntax.
status
\nenum
The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled
id
\nstring
The downtime ID.
relationships
\nobject
All relationships associated with downtime.
created_by
\nobject
The user who created the downtime.
data
\nobject
Data for the user who created the downtime.
id
\nstring
User ID of the downtime creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
monitor
\nobject
The monitor identified by the downtime.
data
\nobject
Data for the monitor.
id
\nstring
Monitor ID of the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
type
\nenum
Downtime resource type. \nAllowed enum values: downtime
default: downtime
included
\n[ <oneOf>]
Array of objects related to the downtime that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Information about the monitor identified by the downtime.
attributes
\nobject
Attributes of the monitor identified by the downtime.
name
\nstring
The name of the monitor identified by the downtime.
id
\nint64
ID of the monitor identified by the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
data
\nobject
Downtime data.
attributes
\nobject
Downtime details.
canceled
\ndate-time
Time that the downtime was canceled.
created
\ndate-time
Creation time of the downtime.
display_timezone
\nstring
The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.
default: UTC
message
\nstring
A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.
modified
\ndate-time
Time that the downtime was last modified.
monitor_identifier
\n<oneOf>
Monitor identifier for the downtime.
Option 1
\nobject
Object of the monitor identifier.
monitor_id [required]
\nint64
ID of the monitor to prevent notifications.
Option 2
\nobject
Object of the monitor tags.
monitor_tags [required]
\n[string]
A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.
mute_first_recovery_notification
\nboolean
If the first recovery notification during a downtime should be muted.
notify_end_states
\n[string]
States that will trigger a monitor notification when the notify_end_types action occurs.
notify_end_types
\n[string]
Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.
schedule
\n<oneOf>
The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.
Option 1
\nobject
A recurring downtime schedule definition.
current_downtime
\nobject
The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.
end
\ndate-time
The end of the current downtime.
start
\ndate-time
The start of the current downtime.
recurrences [required]
\n[object]
A list of downtime recurrences.
duration
\nstring
The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.
rrule
\nstring
The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.
Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.
start
\nstring
ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.
timezone
\nstring
The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.
default: UTC
Option 2
\nobject
A one-time downtime definition.
end
\ndate-time
ISO-8601 Datetime to end the downtime.
start [required]
\ndate-time
ISO-8601 Datetime to start the downtime.
scope
\nstring
The scope to which the downtime applies. Must follow the common search syntax.
status
\nenum
The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled
id
\nstring
The downtime ID.
relationships
\nobject
All relationships associated with downtime.
created_by
\nobject
The user who created the downtime.
data
\nobject
Data for the user who created the downtime.
id
\nstring
User ID of the downtime creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
monitor
\nobject
The monitor identified by the downtime.
data
\nobject
Data for the monitor.
id
\nstring
Monitor ID of the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
type
\nenum
Downtime resource type. \nAllowed enum values: downtime
default: downtime
included
\n[ <oneOf>]
Array of objects related to the downtime that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Information about the monitor identified by the downtime.
attributes
\nobject
Attributes of the monitor identified by the downtime.
name
\nstring
The name of the monitor identified by the downtime.
id
\nint64
ID of the monitor identified by the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
data
\nobject
Downtime data.
attributes
\nobject
Downtime details.
canceled
\ndate-time
Time that the downtime was canceled.
created
\ndate-time
Creation time of the downtime.
display_timezone
\nstring
The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.
default: UTC
message
\nstring
A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same @username notation as events.
modified
\ndate-time
Time that the downtime was last modified.
monitor_identifier
\n<oneOf>
Monitor identifier for the downtime.
Option 1
\nobject
Object of the monitor identifier.
monitor_id [required]
\nint64
ID of the monitor to prevent notifications.
Option 2
\nobject
Object of the monitor tags.
monitor_tags [required]
\n[string]
A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match all provided monitor tags. Setting monitor_tags\nto [*] configures the downtime to mute all monitors for the given scope.
mute_first_recovery_notification
\nboolean
If the first recovery notification during a downtime should be muted.
notify_end_states
\n[string]
States that will trigger a monitor notification when the notify_end_types action occurs.
notify_end_types
\n[string]
Actions that will trigger a monitor notification if the downtime is in the notify_end_types state.
schedule
\n<oneOf>
The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.
Option 1
\nobject
A recurring downtime schedule definition.
current_downtime
\nobject
The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.
end
\ndate-time
The end of the current downtime.
start
\ndate-time
The start of the current downtime.
recurrences [required]
\n[object]
A list of downtime recurrences.
duration
\nstring
The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.
rrule
\nstring
The RRULE standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1.\nMost common rrule options from the iCalendar Spec are supported.
Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION).\nMore examples available in this downtime guide.
start
\nstring
ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.
timezone
\nstring
The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match display_timezone.
default: UTC
Option 2
\nobject
A one-time downtime definition.
end
\ndate-time
ISO-8601 Datetime to end the downtime.
start [required]
\ndate-time
ISO-8601 Datetime to start the downtime.
scope
\nstring
The scope to which the downtime applies. Must follow the common search syntax.
status
\nenum
The current status of the downtime. \nAllowed enum values: active,canceled,ended,scheduled
id
\nstring
The downtime ID.
relationships
\nobject
All relationships associated with downtime.
created_by
\nobject
The user who created the downtime.
data
\nobject
Data for the user who created the downtime.
id
\nstring
User ID of the downtime creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
monitor
\nobject
The monitor identified by the downtime.
data
\nobject
Data for the monitor.
id
\nstring
Monitor ID of the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
type
\nenum
Downtime resource type. \nAllowed enum values: downtime
default: downtime
included
\n[ <oneOf>]
Array of objects related to the downtime that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Information about the monitor identified by the downtime.
attributes
\nobject
Attributes of the monitor identified by the downtime.
name
\nstring
The name of the monitor identified by the downtime.
id
\nint64
ID of the monitor identified by the downtime.
type
\nenum
Monitor resource type. \nAllowed enum values: monitors
default: monitors
data [required]
\n[object]
An array of incident services.
attributes
\nobject
The incident service's attributes from a response.
created
\ndate-time
Timestamp of when the incident service was created.
modified
\ndate-time
Timestamp of when the incident service was modified.
name
\nstring
Name of the incident service.
id [required]
\nstring
The incident service's ID.
relationships
\nobject
The incident service's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident service resource type. \nAllowed enum values: services
default: services
included
\n[ <oneOf>]
Included related resources which the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
meta
\nobject
The metadata object containing pagination metadata.
pagination
\nobject
Pagination properties.
next_offset
\nint64
The index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
The index of the first element in the results.
size
\nint64
Maximum size of pages to return.
data [required]
\n[object]
An array of incident services.
attributes
\nobject
The incident service's attributes from a response.
created
\ndate-time
Timestamp of when the incident service was created.
modified
\ndate-time
Timestamp of when the incident service was modified.
name
\nstring
Name of the incident service.
id [required]
\nstring
The incident service's ID.
relationships
\nobject
The incident service's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident service resource type. \nAllowed enum values: services
default: services
included
\n[ <oneOf>]
Included related resources which the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
meta
\nobject
The metadata object containing pagination metadata.
pagination
\nobject
Pagination properties.
next_offset
\nint64
The index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
The index of the first element in the results.
size
\nint64
Maximum size of pages to return.
data [required]
\nobject
Incident Service data from responses.
attributes
\nobject
The incident service's attributes from a response.
created
\ndate-time
Timestamp of when the incident service was created.
modified
\ndate-time
Timestamp of when the incident service was modified.
name
\nstring
Name of the incident service.
id [required]
\nstring
The incident service's ID.
relationships
\nobject
The incident service's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident service resource type. \nAllowed enum values: services
default: services
included
\n[ <oneOf>]
Included objects from relationships.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident Service data from responses.
attributes
\nobject
The incident service's attributes from a response.
created
\ndate-time
Timestamp of when the incident service was created.
modified
\ndate-time
Timestamp of when the incident service was modified.
name
\nstring
Name of the incident service.
id [required]
\nstring
The incident service's ID.
relationships
\nobject
The incident service's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident service resource type. \nAllowed enum values: services
default: services
included
\n[ <oneOf>]
Included objects from relationships.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident Service data from responses.
attributes
\nobject
The incident service's attributes from a response.
created
\ndate-time
Timestamp of when the incident service was created.
modified
\ndate-time
Timestamp of when the incident service was modified.
name
\nstring
Name of the incident service.
id [required]
\nstring
The incident service's ID.
relationships
\nobject
The incident service's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident service resource type. \nAllowed enum values: services
default: services
included
\n[ <oneOf>]
Included objects from relationships.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident Service data from responses.
attributes
\nobject
The incident service's attributes from a response.
created
\ndate-time
Timestamp of when the incident service was created.
modified
\ndate-time
Timestamp of when the incident service was modified.
name
\nstring
Name of the incident service.
id [required]
\nstring
The incident service's ID.
relationships
\nobject
The incident service's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident service resource type. \nAllowed enum values: services
default: services
included
\n[ <oneOf>]
Included objects from relationships.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident Service data from responses.
attributes
\nobject
The incident service's attributes from a response.
created
\ndate-time
Timestamp of when the incident service was created.
modified
\ndate-time
Timestamp of when the incident service was modified.
name
\nstring
Name of the incident service.
id [required]
\nstring
The incident service's ID.
relationships
\nobject
The incident service's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident service resource type. \nAllowed enum values: services
default: services
included
\n[ <oneOf>]
Included objects from relationships.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident Service data from responses.
attributes
\nobject
The incident service's attributes from a response.
created
\ndate-time
Timestamp of when the incident service was created.
modified
\ndate-time
Timestamp of when the incident service was modified.
name
\nstring
Name of the incident service.
id [required]
\nstring
The incident service's ID.
relationships
\nobject
The incident service's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Incident service resource type. \nAllowed enum values: services
default: services
included
\n[ <oneOf>]
Included objects from relationships.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\n[object]
An array of incident teams.
attributes
\nobject
The incident team's attributes from a response.
created
\ndate-time
Timestamp of when the incident team was created.
modified
\ndate-time
Timestamp of when the incident team was modified.
name
\nstring
Name of the incident team.
id
\nstring
The incident team's ID.
relationships
\nobject
The incident team's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Incident Team resource type. \nAllowed enum values: teams
default: teams
included
\n[ <oneOf>]
Included related resources which the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
meta
\nobject
The metadata object containing pagination metadata.
pagination
\nobject
Pagination properties.
next_offset
\nint64
The index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
The index of the first element in the results.
size
\nint64
Maximum size of pages to return.
data [required]
\n[object]
An array of incident teams.
attributes
\nobject
The incident team's attributes from a response.
created
\ndate-time
Timestamp of when the incident team was created.
modified
\ndate-time
Timestamp of when the incident team was modified.
name
\nstring
Name of the incident team.
id
\nstring
The incident team's ID.
relationships
\nobject
The incident team's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Incident Team resource type. \nAllowed enum values: teams
default: teams
included
\n[ <oneOf>]
Included related resources which the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
meta
\nobject
The metadata object containing pagination metadata.
pagination
\nobject
Pagination properties.
next_offset
\nint64
The index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
The index of the first element in the results.
size
\nint64
Maximum size of pages to return.
data [required]
\nobject
Incident Team data from a response.
attributes
\nobject
The incident team's attributes from a response.
created
\ndate-time
Timestamp of when the incident team was created.
modified
\ndate-time
Timestamp of when the incident team was modified.
name
\nstring
Name of the incident team.
id
\nstring
The incident team's ID.
relationships
\nobject
The incident team's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Incident Team resource type. \nAllowed enum values: teams
default: teams
included
\n[ <oneOf>]
Included objects from relationships.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident Team data from a response.
attributes
\nobject
The incident team's attributes from a response.
created
\ndate-time
Timestamp of when the incident team was created.
modified
\ndate-time
Timestamp of when the incident team was modified.
name
\nstring
Name of the incident team.
id
\nstring
The incident team's ID.
relationships
\nobject
The incident team's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Incident Team resource type. \nAllowed enum values: teams
default: teams
included
\n[ <oneOf>]
Included objects from relationships.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident Team data from a response.
attributes
\nobject
The incident team's attributes from a response.
created
\ndate-time
Timestamp of when the incident team was created.
modified
\ndate-time
Timestamp of when the incident team was modified.
name
\nstring
Name of the incident team.
id
\nstring
The incident team's ID.
relationships
\nobject
The incident team's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Incident Team resource type. \nAllowed enum values: teams
default: teams
included
\n[ <oneOf>]
Included objects from relationships.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident Team data from a response.
attributes
\nobject
The incident team's attributes from a response.
created
\ndate-time
Timestamp of when the incident team was created.
modified
\ndate-time
Timestamp of when the incident team was modified.
name
\nstring
Name of the incident team.
id
\nstring
The incident team's ID.
relationships
\nobject
The incident team's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Incident Team resource type. \nAllowed enum values: teams
default: teams
included
\n[ <oneOf>]
Included objects from relationships.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident Team data from a response.
attributes
\nobject
The incident team's attributes from a response.
created
\ndate-time
Timestamp of when the incident team was created.
modified
\ndate-time
Timestamp of when the incident team was modified.
name
\nstring
Name of the incident team.
id
\nstring
The incident team's ID.
relationships
\nobject
The incident team's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Incident Team resource type. \nAllowed enum values: teams
default: teams
included
\n[ <oneOf>]
Included objects from relationships.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident Team data from a response.
attributes
\nobject
The incident team's attributes from a response.
created
\ndate-time
Timestamp of when the incident team was created.
modified
\ndate-time
Timestamp of when the incident team was modified.
name
\nstring
Name of the incident team.
id
\nstring
The incident team's ID.
relationships
\nobject
The incident team's relationships.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Incident Team resource type. \nAllowed enum values: teams
default: teams
included
\n[ <oneOf>]
Included objects from relationships.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\n[object]
The NotificationRuleArray data.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
meta
\nobject
Response metadata.
pagination
\nobject
Pagination metadata.
next_offset
\nint64
The offset for the next page of results.
offset
\nint64
The current offset in the results.
size
\nint64
The number of results returned per page.
data [required]
\n[object]
The NotificationRuleArray data.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
meta
\nobject
Response metadata.
pagination
\nobject
Pagination metadata.
next_offset
\nint64
The offset for the next page of results.
offset
\nint64
The current offset in the results.
size
\nint64
The number of results returned per page.
data [required]
\nobject
Notification rule data from a response.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
data [required]
\nobject
Notification rule data from a response.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
data [required]
\nobject
Notification rule data from a response.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
data [required]
\nobject
Notification rule data from a response.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
data [required]
\nobject
Notification rule data from a response.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
data [required]
\nobject
Notification rule data from a response.
attributes
\nobject
The notification rule's attributes.
conditions [required]
\n[object]
The conditions that trigger this notification rule.
field [required]
\nstring
The incident field to evaluate
values [required]
\n[string]
The value(s) to compare against. Multiple values are ORed together.
created [required]
\ndate-time
Timestamp when the notification rule was created.
enabled [required]
\nboolean
Whether the notification rule is enabled.
handles [required]
\n[string]
The notification handles (targets) for this rule.
modified [required]
\ndate-time
Timestamp when the notification rule was last modified.
renotify_on
\n[string]
List of incident fields that trigger re-notification when changed.
trigger [required]
\nstring
The trigger event for this notification rule.
visibility [required]
\nenum
The visibility of the notification rule. \nAllowed enum values: all,organization,private
id [required]
\nuuid
The unique identifier of the notification rule.
relationships
\nobject
The notification rule's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
notification_template
\nobject
A relationship reference to a notification template.
data [required]
\nobject
The notification template relationship data.
id [required]
\nuuid
The unique identifier of the notification template.
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
type [required]
\nenum
Notification rules resource type. \nAllowed enum values: incident_notification_rules
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
Option 3
\nobject
A notification template object for inclusion in other resources.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
data [required]
\n[object]
The NotificationTemplateArray data.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
meta
\nobject
Response metadata.
page
\nobject
Pagination metadata.
total_count
\nint64
Total number of notification templates.
total_filtered_count
\nint64
Total number of notification templates matching the filter.
data [required]
\n[object]
The NotificationTemplateArray data.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
meta
\nobject
Response metadata.
page
\nobject
Pagination metadata.
total_count
\nint64
Total number of notification templates.
total_filtered_count
\nint64
Total number of notification templates matching the filter.
data [required]
\nobject
Notification template data from a response.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Notification template data from a response.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Notification template data from a response.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Notification template data from a response.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Notification template data from a response.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\nobject
Notification template data from a response.
attributes
\nobject
The notification template's attributes.
category [required]
\nstring
The category of the notification template.
content [required]
\nstring
The content body of the notification template.
created [required]
\ndate-time
Timestamp when the notification template was created.
modified [required]
\ndate-time
Timestamp when the notification template was last modified.
name [required]
\nstring
The name of the notification template.
subject [required]
\nstring
The subject line of the notification template.
id [required]
\nuuid
The unique identifier of the notification template.
relationships
\nobject
The notification template's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
incident_type
\nobject
Relationship to an incident type.
data [required]
\nobject
Relationship to incident type object.
id [required]
\nstring
The incident type's ID.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Notification templates resource type. \nAllowed enum values: notification_templates
included
\n[ <oneOf>]
Related objects that are included in the response.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Incident type response data.
attributes
\nobject
Incident type's attributes.
createdAt
\ndate-time
Timestamp when the incident type was created.
createdBy
\nstring
A unique identifier that represents the user that created the incident type.
description
\nstring
Text that describes the incident type.
is_default
\nboolean
If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.
lastModifiedBy
\nstring
A unique identifier that represents the user that last modified the incident type.
modifiedAt
\ndate-time
Timestamp when the incident type was last modified.
name [required]
\nstring
The name of the incident type.
prefix
\nstring
The string that will be prepended to the incident title across the Datadog app.
id [required]
\nstring
The incident type's ID.
relationships
\nobject
The incident type's resource relationships.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
google_meet_configuration
\nobject
A reference to a Google Meet Configuration resource.
data [required]
\nobject
The Google Meet configuration relationship data object.
id [required]
\nstring
The unique identifier of the Google Meet configuration.
type [required]
\nstring
The type of the Google Meet configuration.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
microsoft_teams_configuration
\nobject
A reference to a Microsoft Teams Configuration resource.
data [required]
\nobject
The Microsoft Teams configuration relationship data object.
id [required]
\nstring
The unique identifier of the Microsoft Teams configuration.
type [required]
\nstring
The type of the Microsoft Teams configuration.
zoom_configuration
\nobject
A reference to a Zoom configuration resource.
data [required]
\nobject
The Zoom configuration relationship data object.
id [required]
\nstring
The unique identifier of the Zoom configuration.
type [required]
\nstring
The type of the Zoom configuration.
type [required]
\nenum
Incident type resource type. \nAllowed enum values: incident_types
default: incident_types
data [required]
\n[object]
An array of incident attachments.
attributes [required]
\n<oneOf>
The attributes object for an attachment.
Option 1
\nobject
The attributes object for a postmortem attachment.
attachment [required]
\nobject
The postmortem attachment.
documentUrl [required]
\nstring
The URL of this notebook attachment.
title [required]
\nstring
The title of this postmortem attachment.
attachment_type [required]
\nenum
The type of postmortem attachment attributes. \nAllowed enum values: postmortem
default: postmortem
Option 2
\nobject
The attributes object for a link attachment.
attachment [required]
\nobject
The link attachment.
documentUrl [required]
\nstring
The URL of this link attachment.
title [required]
\nstring
The title of this link attachment.
attachment_type [required]
\nenum
The type of link attachment attributes. \nAllowed enum values: link
default: link
modified
\ndate-time
Timestamp when the incident attachment link was last modified.
id [required]
\nstring
A unique identifier that represents the incident attachment.
relationships [required]
\nobject
The incident attachment's relationships.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\n[object]
An array of incident attachments.
attributes [required]
\n<oneOf>
The attributes object for an attachment.
Option 1
\nobject
The attributes object for a postmortem attachment.
attachment [required]
\nobject
The postmortem attachment.
documentUrl [required]
\nstring
The URL of this notebook attachment.
title [required]
\nstring
The title of this postmortem attachment.
attachment_type [required]
\nenum
The type of postmortem attachment attributes. \nAllowed enum values: postmortem
default: postmortem
Option 2
\nobject
The attributes object for a link attachment.
attachment [required]
\nobject
The link attachment.
documentUrl [required]
\nstring
The URL of this link attachment.
title [required]
\nstring
The title of this link attachment.
attachment_type [required]
\nenum
The type of link attachment attributes. \nAllowed enum values: link
default: link
modified
\ndate-time
Timestamp when the incident attachment link was last modified.
id [required]
\nstring
A unique identifier that represents the incident attachment.
relationships [required]
\nobject
The incident attachment's relationships.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\n[object]
An array of incident attachments. Only the attachments that were created or updated by the request are\nreturned.
attributes [required]
\n<oneOf>
The attributes object for an attachment.
Option 1
\nobject
The attributes object for a postmortem attachment.
attachment [required]
\nobject
The postmortem attachment.
documentUrl [required]
\nstring
The URL of this notebook attachment.
title [required]
\nstring
The title of this postmortem attachment.
attachment_type [required]
\nenum
The type of postmortem attachment attributes. \nAllowed enum values: postmortem
default: postmortem
Option 2
\nobject
The attributes object for a link attachment.
attachment [required]
\nobject
The link attachment.
documentUrl [required]
\nstring
The URL of this link attachment.
title [required]
\nstring
The title of this link attachment.
attachment_type [required]
\nenum
The type of link attachment attributes. \nAllowed enum values: link
default: link
modified
\ndate-time
Timestamp when the incident attachment link was last modified.
id [required]
\nstring
A unique identifier that represents the incident attachment.
relationships [required]
\nobject
The incident attachment's relationships.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\n[object]
An array of incident attachments. Only the attachments that were created or updated by the request are\nreturned.
attributes [required]
\n<oneOf>
The attributes object for an attachment.
Option 1
\nobject
The attributes object for a postmortem attachment.
attachment [required]
\nobject
The postmortem attachment.
documentUrl [required]
\nstring
The URL of this notebook attachment.
title [required]
\nstring
The title of this postmortem attachment.
attachment_type [required]
\nenum
The type of postmortem attachment attributes. \nAllowed enum values: postmortem
default: postmortem
Option 2
\nobject
The attributes object for a link attachment.
attachment [required]
\nobject
The link attachment.
documentUrl [required]
\nstring
The URL of this link attachment.
title [required]
\nstring
The title of this link attachment.
attachment_type [required]
\nenum
The type of link attachment attributes. \nAllowed enum values: link
default: link
modified
\ndate-time
Timestamp when the incident attachment link was last modified.
id [required]
\nstring
A unique identifier that represents the incident attachment.
relationships [required]
\nobject
The incident attachment's relationships.
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
The incident attachment resource type. \nAllowed enum values: incident_attachments
default: incident_attachments
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\n[object]
An array of incident integration metadata.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
meta
\nobject
The metadata object containing pagination metadata.
pagination
\nobject
Pagination properties.
next_offset
\nint64
The index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
The index of the first element in the results.
size
\nint64
Maximum size of pages to return.
data [required]
\n[object]
An array of incident integration metadata.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
meta
\nobject
The metadata object containing pagination metadata.
pagination
\nobject
Pagination properties.
next_offset
\nint64
The index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
The index of the first element in the results.
size
\nint64
Maximum size of pages to return.
data [required]
\nobject
Incident integration metadata from a response.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident integration metadata from a response.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident integration metadata from a response.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident integration metadata from a response.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident integration metadata from a response.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident integration metadata from a response.
attributes
\nobject
Incident integration metadata's attributes for a create request.
created
\ndate-time
Timestamp when the incident todo was created.
incident_id
\nstring
UUID of the incident this integration metadata is connected to.
integration_type [required]
\nint32
A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.
metadata [required]
\n<oneOf>
Incident integration metadata's metadata attribute.
Option 1
\nobject
Incident integration metadata for the Slack integration.
channels [required]
\n[object]
Array of Slack channels in this integration metadata.
channel_id [required]
\nstring
Slack channel ID.
channel_name [required]
\nstring
Name of the Slack channel.
redirect_url [required]
\nstring
URL redirecting to the Slack channel.
team_id
\nstring
Slack team ID.
Option 2
\nobject
Incident integration metadata for the Jira integration.
issues [required]
\n[object]
Array of Jira issues in this integration metadata.
account [required]
\nstring
URL of issue's Jira account.
issue_key
\nstring
Jira issue's issue key.
issuetype_id
\nstring
Jira issue's issue type.
project_key [required]
\nstring
Jira issue's project keys.
redirect_url
\nstring
URL redirecting to the Jira issue.
Option 3
\nobject
Incident integration metadata for the Microsoft Teams integration.
teams [required]
\n[object]
Array of Microsoft Teams in this integration metadata.
ms_channel_id [required]
\nstring
Microsoft Teams channel ID.
ms_channel_name [required]
\nstring
Microsoft Teams channel name.
ms_tenant_id [required]
\nstring
Microsoft Teams tenant ID.
redirect_url [required]
\nstring
URL redirecting to the Microsoft Teams channel.
modified
\ndate-time
Timestamp when the incident todo was last modified.
status
\nint32
A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.
id [required]
\nstring
The incident integration metadata's ID.
relationships
\nobject
The incident's integration relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Integration metadata resource type. \nAllowed enum values: incident_integrations
default: incident_integrations
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\n[object]
An array of incident todos.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
meta
\nobject
The metadata object containing pagination metadata.
pagination
\nobject
Pagination properties.
next_offset
\nint64
The index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
The index of the first element in the results.
size
\nint64
Maximum size of pages to return.
data [required]
\n[object]
An array of incident todos.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
meta
\nobject
The metadata object containing pagination metadata.
pagination
\nobject
Pagination properties.
next_offset
\nint64
The index of the first element in the next page of results. Equal to page size added to the current offset.
offset
\nint64
The index of the first element in the results.
size
\nint64
Maximum size of pages to return.
data [required]
\nobject
Incident todo response data.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident todo response data.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident todo response data.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident todo response data.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident todo response data.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data [required]
\nobject
Incident todo response data.
attributes
\nobject
Incident todo's attributes.
assignees [required]
\n[ <oneOf>]
Array of todo assignees.
Option 1
\nstring
Assignee's @-handle.
Option 2
\nobject
Anonymous assignee entity.
icon [required]
\nstring
URL for assignee's icon.
id [required]
\nstring
Anonymous assignee's ID.
name [required]
\nstring
Assignee's name.
source [required]
\nenum
The source of the anonymous assignee. \nAllowed enum values: slack,microsoft_teams
default: slack
completed
\nstring
Timestamp when the todo was completed.
content [required]
\nstring
The follow-up task's content.
created
\ndate-time
Timestamp when the incident todo was created.
due_date
\nstring
Timestamp when the todo should be completed by.
incident_id
\nstring
UUID of the incident this todo is connected to.
modified
\ndate-time
Timestamp when the incident todo was last modified.
id [required]
\nstring
The incident todo's ID.
relationships
\nobject
The incident's relationships from a response.
created_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
last_modified_by_user
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Todo resource type. \nAllowed enum values: incident_todos
default: incident_todos
included
\n[ <oneOf>]
Included related resources that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\n[object]
Array of API keys.
attributes
\nobject
Attributes of a partial API key.
category
\nstring
The category of the API key.
created_at
\nstring
Creation date of the API key.
date_last_used
\ndate-time
Date the API Key was last used.
last4
\nstring
The last four characters of the API key.
modified_at
\nstring
Date the API key was last modified.
name
\nstring
Name of the API key.
remote_config_read_enabled
\nboolean
The remote config read enabled status.
id
\nstring
ID of the API key.
relationships
\nobject
Resources related to the API key.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
API Keys resource type. \nAllowed enum values: api_keys
default: api_keys
included
\n[ <oneOf>]
Array of objects related to the API key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
meta
\nobject
Additional information related to api keys response.
max_allowed
\nint64
Max allowed number of API keys.
page
\nobject
Additional information related to the API keys response.
total_filtered_count
\nint64
Total filtered application key count.
data
\n[object]
Array of API keys.
attributes
\nobject
Attributes of a partial API key.
category
\nstring
The category of the API key.
created_at
\nstring
Creation date of the API key.
date_last_used
\ndate-time
Date the API Key was last used.
last4
\nstring
The last four characters of the API key.
modified_at
\nstring
Date the API key was last modified.
name
\nstring
Name of the API key.
remote_config_read_enabled
\nboolean
The remote config read enabled status.
id
\nstring
ID of the API key.
relationships
\nobject
Resources related to the API key.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
API Keys resource type. \nAllowed enum values: api_keys
default: api_keys
included
\n[ <oneOf>]
Array of objects related to the API key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
meta
\nobject
Additional information related to api keys response.
max_allowed
\nint64
Max allowed number of API keys.
page
\nobject
Additional information related to the API keys response.
total_filtered_count
\nint64
Total filtered application key count.
data
\nobject
Datadog API key.
attributes
\nobject
Attributes of a full API key.
category
\nstring
The category of the API key.
created_at
\ndate-time
Creation date of the API key.
date_last_used
\ndate-time
Date the API Key was last used
key
\nstring
The API key.
last4
\nstring
The last four characters of the API key.
modified_at
\ndate-time
Date the API key was last modified.
name
\nstring
Name of the API key.
remote_config_read_enabled
\nboolean
The remote config read enabled status.
id
\nstring
ID of the API key.
relationships
\nobject
Resources related to the API key.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
API Keys resource type. \nAllowed enum values: api_keys
default: api_keys
included
\n[ <oneOf>]
Array of objects related to the API key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog API key.
attributes
\nobject
Attributes of a full API key.
category
\nstring
The category of the API key.
created_at
\ndate-time
Creation date of the API key.
date_last_used
\ndate-time
Date the API Key was last used
key
\nstring
The API key.
last4
\nstring
The last four characters of the API key.
modified_at
\ndate-time
Date the API key was last modified.
name
\nstring
Name of the API key.
remote_config_read_enabled
\nboolean
The remote config read enabled status.
id
\nstring
ID of the API key.
relationships
\nobject
Resources related to the API key.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
API Keys resource type. \nAllowed enum values: api_keys
default: api_keys
included
\n[ <oneOf>]
Array of objects related to the API key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog API key.
attributes
\nobject
Attributes of a full API key.
category
\nstring
The category of the API key.
created_at
\ndate-time
Creation date of the API key.
date_last_used
\ndate-time
Date the API Key was last used
key
\nstring
The API key.
last4
\nstring
The last four characters of the API key.
modified_at
\ndate-time
Date the API key was last modified.
name
\nstring
Name of the API key.
remote_config_read_enabled
\nboolean
The remote config read enabled status.
id
\nstring
ID of the API key.
relationships
\nobject
Resources related to the API key.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
API Keys resource type. \nAllowed enum values: api_keys
default: api_keys
included
\n[ <oneOf>]
Array of objects related to the API key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog API key.
attributes
\nobject
Attributes of a full API key.
category
\nstring
The category of the API key.
created_at
\ndate-time
Creation date of the API key.
date_last_used
\ndate-time
Date the API Key was last used
key
\nstring
The API key.
last4
\nstring
The last four characters of the API key.
modified_at
\ndate-time
Date the API key was last modified.
name
\nstring
Name of the API key.
remote_config_read_enabled
\nboolean
The remote config read enabled status.
id
\nstring
ID of the API key.
relationships
\nobject
Resources related to the API key.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
API Keys resource type. \nAllowed enum values: api_keys
default: api_keys
included
\n[ <oneOf>]
Array of objects related to the API key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog API key.
attributes
\nobject
Attributes of a full API key.
category
\nstring
The category of the API key.
created_at
\ndate-time
Creation date of the API key.
date_last_used
\ndate-time
Date the API Key was last used
key
\nstring
The API key.
last4
\nstring
The last four characters of the API key.
modified_at
\ndate-time
Date the API key was last modified.
name
\nstring
Name of the API key.
remote_config_read_enabled
\nboolean
The remote config read enabled status.
id
\nstring
ID of the API key.
relationships
\nobject
Resources related to the API key.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
API Keys resource type. \nAllowed enum values: api_keys
default: api_keys
included
\n[ <oneOf>]
Array of objects related to the API key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog API key.
attributes
\nobject
Attributes of a full API key.
category
\nstring
The category of the API key.
created_at
\ndate-time
Creation date of the API key.
date_last_used
\ndate-time
Date the API Key was last used
key
\nstring
The API key.
last4
\nstring
The last four characters of the API key.
modified_at
\ndate-time
Date the API key was last modified.
name
\nstring
Name of the API key.
remote_config_read_enabled
\nboolean
The remote config read enabled status.
id
\nstring
ID of the API key.
relationships
\nobject
Resources related to the API key.
created_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
modified_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
API Keys resource type. \nAllowed enum values: api_keys
default: api_keys
included
\n[ <oneOf>]
Array of objects related to the API key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\n[object]
Array of application keys.
attributes
\nobject
Attributes of a partial application key.
created_at
\nstring
Creation date of the application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\nstring
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
meta
\nobject
Additional information related to the application key response.
max_allowed_per_user
\nint64
Max allowed number of application keys per user.
page
\nobject
Additional information related to the application key response.
total_filtered_count
\nint64
Total filtered application key count.
data
\n[object]
Array of application keys.
attributes
\nobject
Attributes of a partial application key.
created_at
\nstring
Creation date of the application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\nstring
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
meta
\nobject
Additional information related to the application key response.
max_allowed_per_user
\nint64
Max allowed number of application keys per user.
page
\nobject
Additional information related to the application key response.
total_filtered_count
\nint64
Total filtered application key count.
data
\nobject
Datadog application key.
attributes
\nobject
Attributes of a full application key.
created_at
\ndate-time
Creation date of the application key.
key
\nstring
The application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\ndate-time
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog application key.
attributes
\nobject
Attributes of a full application key.
created_at
\ndate-time
Creation date of the application key.
key
\nstring
The application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\ndate-time
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog application key.
attributes
\nobject
Attributes of a full application key.
created_at
\ndate-time
Creation date of the application key.
key
\nstring
The application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\ndate-time
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog application key.
attributes
\nobject
Attributes of a full application key.
created_at
\ndate-time
Creation date of the application key.
key
\nstring
The application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\ndate-time
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\n[object]
Array of application keys.
attributes
\nobject
Attributes of a partial application key.
created_at
\nstring
Creation date of the application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\nstring
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
meta
\nobject
Additional information related to the application key response.
max_allowed_per_user
\nint64
Max allowed number of application keys per user.
page
\nobject
Additional information related to the application key response.
total_filtered_count
\nint64
Total filtered application key count.
data
\n[object]
Array of application keys.
attributes
\nobject
Attributes of a partial application key.
created_at
\nstring
Creation date of the application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\nstring
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
meta
\nobject
Additional information related to the application key response.
max_allowed_per_user
\nint64
Max allowed number of application keys per user.
page
\nobject
Additional information related to the application key response.
total_filtered_count
\nint64
Total filtered application key count.
data
\nobject
Datadog application key.
attributes
\nobject
Attributes of a full application key.
created_at
\ndate-time
Creation date of the application key.
key
\nstring
The application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\ndate-time
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog application key.
attributes
\nobject
Attributes of a full application key.
created_at
\ndate-time
Creation date of the application key.
key
\nstring
The application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\ndate-time
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog application key.
attributes
\nobject
Attributes of a full application key.
created_at
\ndate-time
Creation date of the application key.
key
\nstring
The application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\ndate-time
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog application key.
attributes
\nobject
Attributes of a full application key.
created_at
\ndate-time
Creation date of the application key.
key
\nstring
The application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\ndate-time
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog application key.
attributes
\nobject
Attributes of a full application key.
created_at
\ndate-time
Creation date of the application key.
key
\nstring
The application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\ndate-time
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog application key.
attributes
\nobject
Attributes of a full application key.
created_at
\ndate-time
Creation date of the application key.
key
\nstring
The application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\ndate-time
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\n[object]
A list of monitor notification rules.
attributes
\nobject
Attributes of the monitor notification rule.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
The scope to which the monitor applied.
fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Filter used to associate the notification rule with monitors.
Option 1
\nobject
Filter monitors by tags. Monitors must match all tags.
tags [required]
\n[string]
A list of monitor tags.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rules.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\n[object]
A list of monitor notification rules.
attributes
\nobject
Attributes of the monitor notification rule.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
The scope to which the monitor applied.
fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Filter used to associate the notification rule with monitors.
Option 1
\nobject
Filter monitors by tags. Monitors must match all tags.
tags [required]
\n[string]
A list of monitor tags.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rules.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Monitor notification rule data.
attributes
\nobject
Attributes of the monitor notification rule.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
The scope to which the monitor applied.
fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Filter used to associate the notification rule with monitors.
Option 1
\nobject
Filter monitors by tags. Monitors must match all tags.
tags [required]
\n[string]
A list of monitor tags.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rule that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Monitor notification rule data.
attributes
\nobject
Attributes of the monitor notification rule.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
The scope to which the monitor applied.
fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Filter used to associate the notification rule with monitors.
Option 1
\nobject
Filter monitors by tags. Monitors must match all tags.
tags [required]
\n[string]
A list of monitor tags.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rule that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Monitor notification rule data.
attributes
\nobject
Attributes of the monitor notification rule.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
The scope to which the monitor applied.
fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Filter used to associate the notification rule with monitors.
Option 1
\nobject
Filter monitors by tags. Monitors must match all tags.
tags [required]
\n[string]
A list of monitor tags.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rule that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Monitor notification rule data.
attributes
\nobject
Attributes of the monitor notification rule.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
The scope to which the monitor applied.
fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Filter used to associate the notification rule with monitors.
Option 1
\nobject
Filter monitors by tags. Monitors must match all tags.
tags [required]
\n[string]
A list of monitor tags.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rule that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Monitor notification rule data.
attributes
\nobject
Attributes of the monitor notification rule.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
The scope to which the monitor applied.
fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Filter used to associate the notification rule with monitors.
Option 1
\nobject
Filter monitors by tags. Monitors must match all tags.
tags [required]
\n[string]
A list of monitor tags.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rule that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Monitor notification rule data.
attributes
\nobject
Attributes of the monitor notification rule.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
The scope to which the monitor applied.
fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Filter used to associate the notification rule with monitors.
Option 1
\nobject
Filter monitors by tags. Monitors must match all tags.
tags [required]
\n[string]
A list of monitor tags.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rule that the user requested.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Defines the main on-call responder object for a team, including relationships and metadata.
id
\nstring
Unique identifier of the on-call responder configuration.
relationships
\nobject
Relationship objects linked to a team's on-call responder configuration, including escalations and responders.
escalations
\nobject
Defines the escalation policy steps linked to the team's on-call configuration.
data
\n[object]
Array of escalation step references.
id [required]
\nstring
Unique identifier of the escalation step.
type [required]
\nenum
Identifies the resource type for escalation policy steps linked to a team's on-call configuration. \nAllowed enum values: escalation_policy_steps
default: escalation_policy_steps
responders
\nobject
Defines the list of users assigned as on-call responders for the team.
data
\n[object]
Array of user references associated as responders.
id [required]
\nstring
Unique identifier of the responder.
type [required]
\nenum
Identifies the resource type for individual user entities associated with on-call response. \nAllowed enum values: users
default: users
type [required]
\nenum
Represents the resource type for a group of users assigned to handle on-call duties within a team. \nAllowed enum values: team_oncall_responders
default: team_oncall_responders
included
\n[ <oneOf>]
The TeamOnCallResponders included.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Represents an escalation policy step.
id
\nstring
Unique identifier of the escalation step.
relationships
\nobject
Contains the relationships of an escalation object, including its responders.
responders
\nobject
Lists the users involved in a specific step of the escalation policy.
data
\n[object]
Array of user references assigned as responders for this escalation step.
id [required]
\nstring
Unique identifier of the user assigned to the escalation step.
type [required]
\nenum
Represents the resource type for users assigned as responders in an escalation step. \nAllowed enum values: users
default: users
type [required]
\nenum
Represents the resource type for individual steps in an escalation policy used during incident response. \nAllowed enum values: escalation_policy_steps
default: escalation_policy_steps
data
\nobject
Defines the main on-call responder object for a team, including relationships and metadata.
id
\nstring
Unique identifier of the on-call responder configuration.
relationships
\nobject
Relationship objects linked to a team's on-call responder configuration, including escalations and responders.
escalations
\nobject
Defines the escalation policy steps linked to the team's on-call configuration.
data
\n[object]
Array of escalation step references.
id [required]
\nstring
Unique identifier of the escalation step.
type [required]
\nenum
Identifies the resource type for escalation policy steps linked to a team's on-call configuration. \nAllowed enum values: escalation_policy_steps
default: escalation_policy_steps
responders
\nobject
Defines the list of users assigned as on-call responders for the team.
data
\n[object]
Array of user references associated as responders.
id [required]
\nstring
Unique identifier of the responder.
type [required]
\nenum
Identifies the resource type for individual user entities associated with on-call response. \nAllowed enum values: users
default: users
type [required]
\nenum
Represents the resource type for a group of users assigned to handle on-call duties within a team. \nAllowed enum values: team_oncall_responders
default: team_oncall_responders
included
\n[ <oneOf>]
The TeamOnCallResponders included.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Represents an escalation policy step.
id
\nstring
Unique identifier of the escalation step.
relationships
\nobject
Contains the relationships of an escalation object, including its responders.
responders
\nobject
Lists the users involved in a specific step of the escalation policy.
data
\n[object]
Array of user references assigned as responders for this escalation step.
id [required]
\nstring
Unique identifier of the user assigned to the escalation step.
type [required]
\nenum
Represents the resource type for users assigned as responders in an escalation step. \nAllowed enum values: users
default: users
type [required]
\nenum
Represents the resource type for individual steps in an escalation policy used during incident response. \nAllowed enum values: escalation_policy_steps
default: escalation_policy_steps
data
\n[object]
List of powerpack definitions.
attributes
\nobject
Powerpack attribute object.
description
\nstring
Description of this powerpack.
group_widget [required]
\nobject
Powerpack group widget definition object.
definition [required]
\nobject
Powerpack group widget object.
layout_type [required]
\nstring
Layout type of widgets.
show_title
\nboolean
Boolean indicating whether powerpack group title should be visible or not.
title
\nstring
Name for the group widget.
type [required]
\nstring
Type of widget, must be group.
widgets [required]
\n[object]
Widgets inside the powerpack.
definition [required]
\nobject
Information about widget.
layout
\nobject
Powerpack inner widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
layout
\nobject
Powerpack group widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert
name [required]
\nstring
Name of the powerpack.
tags
\n[string]
List of tags to identify this powerpack.
template_variables
\n[object]
List of template variables for this powerpack.
available_values
\n[string]
The list of values that the template variable drop-down is limited to.
defaults
\n[string]
One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.
name [required]
\nstring
The name of the variable.
prefix
\nstring
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
id
\nstring
ID of the powerpack.
relationships
\nobject
Powerpack relationship object.
author
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nstring
Type of widget, must be powerpack.
included
\n[object]
Array of objects related to the users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
links
\nobject
Links attributes.
first
\nstring
Link to last page.
last
\nstring
Link to first page.
next
\nstring
Link for the next set of results.
prev
\nstring
Link for the previous set of results.
self
\nstring
Link to current page.
meta
\nobject
Powerpack response metadata.
pagination
\nobject
Powerpack response pagination metadata.
first_offset
\nint64
The first offset.
last_offset
\nint64
The last offset.
limit
\nint64
Pagination limit.
next_offset
\nint64
The next offset.
offset
\nint64
The offset.
prev_offset
\nint64
The previous offset.
total
\nint64
Total results.
type
\nstring
Offset type.
data
\n[object]
List of powerpack definitions.
attributes
\nobject
Powerpack attribute object.
description
\nstring
Description of this powerpack.
group_widget [required]
\nobject
Powerpack group widget definition object.
definition [required]
\nobject
Powerpack group widget object.
layout_type [required]
\nstring
Layout type of widgets.
show_title
\nboolean
Boolean indicating whether powerpack group title should be visible or not.
title
\nstring
Name for the group widget.
type [required]
\nstring
Type of widget, must be group.
widgets [required]
\n[object]
Widgets inside the powerpack.
definition [required]
\nobject
Information about widget.
layout
\nobject
Powerpack inner widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
layout
\nobject
Powerpack group widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert
name [required]
\nstring
Name of the powerpack.
tags
\n[string]
List of tags to identify this powerpack.
template_variables
\n[object]
List of template variables for this powerpack.
available_values
\n[string]
The list of values that the template variable drop-down is limited to.
defaults
\n[string]
One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.
name [required]
\nstring
The name of the variable.
prefix
\nstring
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
id
\nstring
ID of the powerpack.
relationships
\nobject
Powerpack relationship object.
author
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nstring
Type of widget, must be powerpack.
included
\n[object]
Array of objects related to the users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
links
\nobject
Links attributes.
first
\nstring
Link to last page.
last
\nstring
Link to first page.
next
\nstring
Link for the next set of results.
prev
\nstring
Link for the previous set of results.
self
\nstring
Link to current page.
meta
\nobject
Powerpack response metadata.
pagination
\nobject
Powerpack response pagination metadata.
first_offset
\nint64
The first offset.
last_offset
\nint64
The last offset.
limit
\nint64
Pagination limit.
next_offset
\nint64
The next offset.
offset
\nint64
The offset.
prev_offset
\nint64
The previous offset.
total
\nint64
Total results.
type
\nstring
Offset type.
data
\nobject
Powerpack data object.
attributes
\nobject
Powerpack attribute object.
description
\nstring
Description of this powerpack.
group_widget [required]
\nobject
Powerpack group widget definition object.
definition [required]
\nobject
Powerpack group widget object.
layout_type [required]
\nstring
Layout type of widgets.
show_title
\nboolean
Boolean indicating whether powerpack group title should be visible or not.
title
\nstring
Name for the group widget.
type [required]
\nstring
Type of widget, must be group.
widgets [required]
\n[object]
Widgets inside the powerpack.
definition [required]
\nobject
Information about widget.
layout
\nobject
Powerpack inner widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
layout
\nobject
Powerpack group widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert
name [required]
\nstring
Name of the powerpack.
tags
\n[string]
List of tags to identify this powerpack.
template_variables
\n[object]
List of template variables for this powerpack.
available_values
\n[string]
The list of values that the template variable drop-down is limited to.
defaults
\n[string]
One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.
name [required]
\nstring
The name of the variable.
prefix
\nstring
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
id
\nstring
ID of the powerpack.
relationships
\nobject
Powerpack relationship object.
author
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nstring
Type of widget, must be powerpack.
included
\n[object]
Array of objects related to the users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Powerpack data object.
attributes
\nobject
Powerpack attribute object.
description
\nstring
Description of this powerpack.
group_widget [required]
\nobject
Powerpack group widget definition object.
definition [required]
\nobject
Powerpack group widget object.
layout_type [required]
\nstring
Layout type of widgets.
show_title
\nboolean
Boolean indicating whether powerpack group title should be visible or not.
title
\nstring
Name for the group widget.
type [required]
\nstring
Type of widget, must be group.
widgets [required]
\n[object]
Widgets inside the powerpack.
definition [required]
\nobject
Information about widget.
layout
\nobject
Powerpack inner widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
layout
\nobject
Powerpack group widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert
name [required]
\nstring
Name of the powerpack.
tags
\n[string]
List of tags to identify this powerpack.
template_variables
\n[object]
List of template variables for this powerpack.
available_values
\n[string]
The list of values that the template variable drop-down is limited to.
defaults
\n[string]
One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.
name [required]
\nstring
The name of the variable.
prefix
\nstring
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
id
\nstring
ID of the powerpack.
relationships
\nobject
Powerpack relationship object.
author
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nstring
Type of widget, must be powerpack.
included
\n[object]
Array of objects related to the users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Powerpack data object.
attributes
\nobject
Powerpack attribute object.
description
\nstring
Description of this powerpack.
group_widget [required]
\nobject
Powerpack group widget definition object.
definition [required]
\nobject
Powerpack group widget object.
layout_type [required]
\nstring
Layout type of widgets.
show_title
\nboolean
Boolean indicating whether powerpack group title should be visible or not.
title
\nstring
Name for the group widget.
type [required]
\nstring
Type of widget, must be group.
widgets [required]
\n[object]
Widgets inside the powerpack.
definition [required]
\nobject
Information about widget.
layout
\nobject
Powerpack inner widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
layout
\nobject
Powerpack group widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert
name [required]
\nstring
Name of the powerpack.
tags
\n[string]
List of tags to identify this powerpack.
template_variables
\n[object]
List of template variables for this powerpack.
available_values
\n[string]
The list of values that the template variable drop-down is limited to.
defaults
\n[string]
One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.
name [required]
\nstring
The name of the variable.
prefix
\nstring
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
id
\nstring
ID of the powerpack.
relationships
\nobject
Powerpack relationship object.
author
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nstring
Type of widget, must be powerpack.
included
\n[object]
Array of objects related to the users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Powerpack data object.
attributes
\nobject
Powerpack attribute object.
description
\nstring
Description of this powerpack.
group_widget [required]
\nobject
Powerpack group widget definition object.
definition [required]
\nobject
Powerpack group widget object.
layout_type [required]
\nstring
Layout type of widgets.
show_title
\nboolean
Boolean indicating whether powerpack group title should be visible or not.
title
\nstring
Name for the group widget.
type [required]
\nstring
Type of widget, must be group.
widgets [required]
\n[object]
Widgets inside the powerpack.
definition [required]
\nobject
Information about widget.
layout
\nobject
Powerpack inner widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
layout
\nobject
Powerpack group widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert
name [required]
\nstring
Name of the powerpack.
tags
\n[string]
List of tags to identify this powerpack.
template_variables
\n[object]
List of template variables for this powerpack.
available_values
\n[string]
The list of values that the template variable drop-down is limited to.
defaults
\n[string]
One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.
name [required]
\nstring
The name of the variable.
prefix
\nstring
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
id
\nstring
ID of the powerpack.
relationships
\nobject
Powerpack relationship object.
author
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nstring
Type of widget, must be powerpack.
included
\n[object]
Array of objects related to the users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Powerpack data object.
attributes
\nobject
Powerpack attribute object.
description
\nstring
Description of this powerpack.
group_widget [required]
\nobject
Powerpack group widget definition object.
definition [required]
\nobject
Powerpack group widget object.
layout_type [required]
\nstring
Layout type of widgets.
show_title
\nboolean
Boolean indicating whether powerpack group title should be visible or not.
title
\nstring
Name for the group widget.
type [required]
\nstring
Type of widget, must be group.
widgets [required]
\n[object]
Widgets inside the powerpack.
definition [required]
\nobject
Information about widget.
layout
\nobject
Powerpack inner widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
layout
\nobject
Powerpack group widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert
name [required]
\nstring
Name of the powerpack.
tags
\n[string]
List of tags to identify this powerpack.
template_variables
\n[object]
List of template variables for this powerpack.
available_values
\n[string]
The list of values that the template variable drop-down is limited to.
defaults
\n[string]
One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.
name [required]
\nstring
The name of the variable.
prefix
\nstring
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
id
\nstring
ID of the powerpack.
relationships
\nobject
Powerpack relationship object.
author
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nstring
Type of widget, must be powerpack.
included
\n[object]
Array of objects related to the users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Powerpack data object.
attributes
\nobject
Powerpack attribute object.
description
\nstring
Description of this powerpack.
group_widget [required]
\nobject
Powerpack group widget definition object.
definition [required]
\nobject
Powerpack group widget object.
layout_type [required]
\nstring
Layout type of widgets.
show_title
\nboolean
Boolean indicating whether powerpack group title should be visible or not.
title
\nstring
Name for the group widget.
type [required]
\nstring
Type of widget, must be group.
widgets [required]
\n[object]
Widgets inside the powerpack.
definition [required]
\nobject
Information about widget.
layout
\nobject
Powerpack inner widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
layout
\nobject
Powerpack group widget layout.
height [required]
\nint64
The height of the widget. Should be a non-negative integer.
width [required]
\nint64
The width of the widget. Should be a non-negative integer.
x [required]
\nint64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
\nint64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
live_span
\nenum
The available timeframes depend on the widget you are using. \nAllowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert
name [required]
\nstring
Name of the powerpack.
tags
\n[string]
List of tags to identify this powerpack.
template_variables
\n[object]
List of template variables for this powerpack.
available_values
\n[string]
The list of values that the template variable drop-down is limited to.
defaults
\n[string]
One or many template variable default values within the saved view, which are unioned together using OR if more than one is specified.
name [required]
\nstring
The name of the variable.
prefix
\nstring
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
id
\nstring
ID of the powerpack.
relationships
\nobject
Powerpack relationship object.
author
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nstring
Type of widget, must be powerpack.
included
\n[object]
Array of objects related to the users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\n[object]
Array of returned users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the users.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
meta
\nobject
Object describing meta attributes of response.
page
\nobject
Pagination object.
total_count
\nint64
Total count.
total_filtered_count
\nint64
Total count of elements matched by the filter.
data
\n[object]
Array of returned users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the users.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
meta
\nobject
Object describing meta attributes of response.
page
\nobject
Pagination object.
total_count
\nint64
Total count.
total_filtered_count
\nint64
Total count of elements matched by the filter.
data
\n[object]
Array of returned users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the users.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
meta
\nobject
Object describing meta attributes of response.
page
\nobject
Pagination object.
total_count
\nint64
Total count.
total_filtered_count
\nint64
Total count of elements matched by the filter.
data
\n[object]
Array of returned users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the users.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
meta
\nobject
Object describing meta attributes of response.
page
\nobject
Pagination object.
total_count
\nint64
Total count.
total_filtered_count
\nint64
Total count of elements matched by the filter.
data
\n[object]
Array of returned users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the users.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
meta
\nobject
Object describing meta attributes of response.
page
\nobject
Pagination object.
total_count
\nint64
Total count.
total_filtered_count
\nint64
Total count of elements matched by the filter.
data
\n[object]
Array of returned users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the users.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
meta
\nobject
Object describing meta attributes of response.
page
\nobject
Pagination object.
total_count
\nint64
Total count.
total_filtered_count
\nint64
Total count of elements matched by the filter.
data
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the user.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
data
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the user.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
data
\n[object]
Array of application keys.
attributes
\nobject
Attributes of a partial application key.
created_at
\nstring
Creation date of the application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\nstring
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
meta
\nobject
Additional information related to the application key response.
max_allowed_per_user
\nint64
Max allowed number of application keys per user.
page
\nobject
Additional information related to the application key response.
total_filtered_count
\nint64
Total filtered application key count.
data
\n[object]
Array of application keys.
attributes
\nobject
Attributes of a partial application key.
created_at
\nstring
Creation date of the application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\nstring
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
meta
\nobject
Additional information related to the application key response.
max_allowed_per_user
\nint64
Max allowed number of application keys per user.
page
\nobject
Additional information related to the application key response.
total_filtered_count
\nint64
Total filtered application key count.
data
\nobject
Datadog application key.
attributes
\nobject
Attributes of a full application key.
created_at
\ndate-time
Creation date of the application key.
key
\nstring
The application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\ndate-time
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Datadog application key.
attributes
\nobject
Attributes of a full application key.
created_at
\ndate-time
Creation date of the application key.
key
\nstring
The application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\ndate-time
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Partial Datadog application key.
attributes
\nobject
Attributes of a partial application key.
created_at
\nstring
Creation date of the application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\nstring
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Partial Datadog application key.
attributes
\nobject
Attributes of a partial application key.
created_at
\nstring
Creation date of the application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\nstring
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Partial Datadog application key.
attributes
\nobject
Attributes of a partial application key.
created_at
\nstring
Creation date of the application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\nstring
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\nobject
Partial Datadog application key.
attributes
\nobject
Attributes of a partial application key.
created_at
\nstring
Creation date of the application key.
last4
\nstring
The last four characters of the application key.
last_used_at
\nstring
Last usage timestamp of the application key.
name
\nstring
Name of the application key.
scopes
\n[string]
Array of scopes to grant the application key.
id
\nstring
ID of the application key.
relationships
\nobject
Resources related to the application key.
owned_by
\nobject
Relationship to user.
data [required]
\nobject
Relationship to user object.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Application Keys resource type. \nAllowed enum values: application_keys
default: application_keys
included
\n[ <oneOf>]
Array of objects related to the application key.
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
Option 3
\nobject
The definition of LeakedKey object.
attributes [required]
\nobject
The definition of LeakedKeyAttributes object.
date [required]
\ndate-time
The LeakedKeyAttributes date.
leak_source
\nstring
The LeakedKeyAttributes leak_source.
id [required]
\nstring
The LeakedKey id.
type [required]
\nenum
The definition of LeakedKeyType object. \nAllowed enum values: leaked_keys
default: leaked_keys
data
\n[object]
Teams response data
attributes [required]
\nobject
Team attributes
avatar
\nstring
Unicode representation of the avatar for the team, limited to a single grapheme
banner
\nint64
Banner selection for the team
created_at
\ndate-time
Creation date of the team
description
\nstring
Free-form markdown description/content for the team's homepage
handle [required]
\nstring
The team's identifier
hidden_modules
\n[string]
Collection of hidden modules for the team
link_count
\nint32
The number of links belonging to the team
modified_at
\ndate-time
Modification date of the team
name [required]
\nstring
The name of the team
summary
\nstring
A brief summary of the team, derived from the description
user_count
\nint32
The number of users belonging to the team
visible_modules
\n[string]
Collection of visible modules for the team
id [required]
\nstring
The team's identifier
relationships
\nobject
Resources related to a team
team_links
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
user_team_permissions
\nobject
Relationship between a user team permission and a team
data
\nobject
Related user team permission data
id [required]
\nstring
The ID of the user team permission
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Links attributes.
related
\nstring
Related link.
type [required]
\nenum
Team type \nAllowed enum values: team
default: team
included
\n[ <oneOf>]
Resources related to the team
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Team link
attributes [required]
\nobject
Team link attributes
label [required]
\nstring
The link's label
position
\nint32
The link's position, used to sort links for the team
team_id
\nstring
ID of the team the link is associated with
url [required]
\nstring
The URL for the link
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
Option 3
\nobject
A user's permissions for a given team
attributes
\nobject
User team permission attributes
permissions
\nobject
Object of team permission actions and boolean values that a logged in user can perform on this team.
id [required]
\nstring
The user team permission's identifier
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Teams response links.
first
\nstring
First link.
last
\nstring
Last link.
next
\nstring
Next link.
prev
\nstring
Previous link.
self
\nstring
Current link.
meta
\nobject
Teams response metadata.
pagination
\nobject
Teams response metadata.
first_offset
\nint64
The first offset.
last_offset
\nint64
The last offset.
limit
\nint64
Pagination limit.
next_offset
\nint64
The next offset.
offset
\nint64
The offset.
prev_offset
\nint64
The previous offset.
total
\nint64
Total results.
type
\nstring
Offset type.
data
\n[object]
Teams response data
attributes [required]
\nobject
Team attributes
avatar
\nstring
Unicode representation of the avatar for the team, limited to a single grapheme
banner
\nint64
Banner selection for the team
created_at
\ndate-time
Creation date of the team
description
\nstring
Free-form markdown description/content for the team's homepage
handle [required]
\nstring
The team's identifier
hidden_modules
\n[string]
Collection of hidden modules for the team
link_count
\nint32
The number of links belonging to the team
modified_at
\ndate-time
Modification date of the team
name [required]
\nstring
The name of the team
summary
\nstring
A brief summary of the team, derived from the description
user_count
\nint32
The number of users belonging to the team
visible_modules
\n[string]
Collection of visible modules for the team
id [required]
\nstring
The team's identifier
relationships
\nobject
Resources related to a team
team_links
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
user_team_permissions
\nobject
Relationship between a user team permission and a team
data
\nobject
Related user team permission data
id [required]
\nstring
The ID of the user team permission
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Links attributes.
related
\nstring
Related link.
type [required]
\nenum
Team type \nAllowed enum values: team
default: team
included
\n[ <oneOf>]
Resources related to the team
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Team link
attributes [required]
\nobject
Team link attributes
label [required]
\nstring
The link's label
position
\nint32
The link's position, used to sort links for the team
team_id
\nstring
ID of the team the link is associated with
url [required]
\nstring
The URL for the link
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
Option 3
\nobject
A user's permissions for a given team
attributes
\nobject
User team permission attributes
permissions
\nobject
Object of team permission actions and boolean values that a logged in user can perform on this team.
id [required]
\nstring
The user team permission's identifier
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Teams response links.
first
\nstring
First link.
last
\nstring
Last link.
next
\nstring
Next link.
prev
\nstring
Previous link.
self
\nstring
Current link.
meta
\nobject
Teams response metadata.
pagination
\nobject
Teams response metadata.
first_offset
\nint64
The first offset.
last_offset
\nint64
The last offset.
limit
\nint64
Pagination limit.
next_offset
\nint64
The next offset.
offset
\nint64
The offset.
prev_offset
\nint64
The previous offset.
total
\nint64
Total results.
type
\nstring
Offset type.
data
\n[object]
Teams response data
attributes [required]
\nobject
Team attributes
avatar
\nstring
Unicode representation of the avatar for the team, limited to a single grapheme
banner
\nint64
Banner selection for the team
created_at
\ndate-time
Creation date of the team
description
\nstring
Free-form markdown description/content for the team's homepage
handle [required]
\nstring
The team's identifier
hidden_modules
\n[string]
Collection of hidden modules for the team
link_count
\nint32
The number of links belonging to the team
modified_at
\ndate-time
Modification date of the team
name [required]
\nstring
The name of the team
summary
\nstring
A brief summary of the team, derived from the description
user_count
\nint32
The number of users belonging to the team
visible_modules
\n[string]
Collection of visible modules for the team
id [required]
\nstring
The team's identifier
relationships
\nobject
Resources related to a team
team_links
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
user_team_permissions
\nobject
Relationship between a user team permission and a team
data
\nobject
Related user team permission data
id [required]
\nstring
The ID of the user team permission
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Links attributes.
related
\nstring
Related link.
type [required]
\nenum
Team type \nAllowed enum values: team
default: team
included
\n[ <oneOf>]
Resources related to the team
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Team link
attributes [required]
\nobject
Team link attributes
label [required]
\nstring
The link's label
position
\nint32
The link's position, used to sort links for the team
team_id
\nstring
ID of the team the link is associated with
url [required]
\nstring
The URL for the link
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
Option 3
\nobject
A user's permissions for a given team
attributes
\nobject
User team permission attributes
permissions
\nobject
Object of team permission actions and boolean values that a logged in user can perform on this team.
id [required]
\nstring
The user team permission's identifier
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Teams response links.
first
\nstring
First link.
last
\nstring
Last link.
next
\nstring
Next link.
prev
\nstring
Previous link.
self
\nstring
Current link.
meta
\nobject
Teams response metadata.
pagination
\nobject
Teams response metadata.
first_offset
\nint64
The first offset.
last_offset
\nint64
The last offset.
limit
\nint64
Pagination limit.
next_offset
\nint64
The next offset.
offset
\nint64
The offset.
prev_offset
\nint64
The previous offset.
total
\nint64
Total results.
type
\nstring
Offset type.
data
\n[object]
Teams response data
attributes [required]
\nobject
Team attributes
avatar
\nstring
Unicode representation of the avatar for the team, limited to a single grapheme
banner
\nint64
Banner selection for the team
created_at
\ndate-time
Creation date of the team
description
\nstring
Free-form markdown description/content for the team's homepage
handle [required]
\nstring
The team's identifier
hidden_modules
\n[string]
Collection of hidden modules for the team
link_count
\nint32
The number of links belonging to the team
modified_at
\ndate-time
Modification date of the team
name [required]
\nstring
The name of the team
summary
\nstring
A brief summary of the team, derived from the description
user_count
\nint32
The number of users belonging to the team
visible_modules
\n[string]
Collection of visible modules for the team
id [required]
\nstring
The team's identifier
relationships
\nobject
Resources related to a team
team_links
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
user_team_permissions
\nobject
Relationship between a user team permission and a team
data
\nobject
Related user team permission data
id [required]
\nstring
The ID of the user team permission
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Links attributes.
related
\nstring
Related link.
type [required]
\nenum
Team type \nAllowed enum values: team
default: team
included
\n[ <oneOf>]
Resources related to the team
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
Team link
attributes [required]
\nobject
Team link attributes
label [required]
\nstring
The link's label
position
\nint32
The link's position, used to sort links for the team
team_id
\nstring
ID of the team the link is associated with
url [required]
\nstring
The URL for the link
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
Option 3
\nobject
A user's permissions for a given team
attributes
\nobject
User team permission attributes
permissions
\nobject
Object of team permission actions and boolean values that a logged in user can perform on this team.
id [required]
\nstring
The user team permission's identifier
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Teams response links.
first
\nstring
First link.
last
\nstring
Last link.
next
\nstring
Next link.
prev
\nstring
Previous link.
self
\nstring
Current link.
meta
\nobject
Teams response metadata.
pagination
\nobject
Teams response metadata.
first_offset
\nint64
The first offset.
last_offset
\nint64
The last offset.
limit
\nint64
Pagination limit.
next_offset
\nint64
The next offset.
offset
\nint64
The offset.
prev_offset
\nint64
The previous offset.
total
\nint64
Total results.
type
\nstring
Offset type.
data
\n[object]
Team memberships response data
attributes
\nobject
Team membership attributes
provisioned_by
\nstring
The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.
provisioned_by_id
\nstring
UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.
role
\nenum
The user's role within the team \nAllowed enum values: admin
id [required]
\nstring
The ID of a user's relationship with a team
relationships
\nobject
Relationship between membership and a user
team
\nobject
Relationship between team membership and team
data [required]
\nobject
The team associated with the membership
id [required]
\nstring
The ID of the team associated with the membership
type [required]
\nenum
User team team type \nAllowed enum values: team
default: team
user
\nobject
Relationship between team membership and user
data [required]
\nobject
A user's relationship with a team
id [required]
\nstring
The ID of the user associated with the team
type [required]
\nenum
User team user type \nAllowed enum values: users
default: users
type [required]
\nenum
Team membership type \nAllowed enum values: team_memberships
default: team_memberships
included
\n[ <oneOf>]
Resources related to the team memberships
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
A team
attributes [required]
\nobject
Team attributes
avatar
\nstring
Unicode representation of the avatar for the team, limited to a single grapheme
banner
\nint64
Banner selection for the team
created_at
\ndate-time
Creation date of the team
description
\nstring
Free-form markdown description/content for the team's homepage
handle [required]
\nstring
The team's identifier
hidden_modules
\n[string]
Collection of hidden modules for the team
link_count
\nint32
The number of links belonging to the team
modified_at
\ndate-time
Modification date of the team
name [required]
\nstring
The name of the team
summary
\nstring
A brief summary of the team, derived from the description
user_count
\nint32
The number of users belonging to the team
visible_modules
\n[string]
Collection of visible modules for the team
id [required]
\nstring
The team's identifier
relationships
\nobject
Resources related to a team
team_links
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
user_team_permissions
\nobject
Relationship between a user team permission and a team
data
\nobject
Related user team permission data
id [required]
\nstring
The ID of the user team permission
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Links attributes.
related
\nstring
Related link.
type [required]
\nenum
Team type \nAllowed enum values: team
default: team
links
\nobject
Teams response links.
first
\nstring
First link.
last
\nstring
Last link.
next
\nstring
Next link.
prev
\nstring
Previous link.
self
\nstring
Current link.
meta
\nobject
Teams response metadata.
pagination
\nobject
Teams response metadata.
first_offset
\nint64
The first offset.
last_offset
\nint64
The last offset.
limit
\nint64
Pagination limit.
next_offset
\nint64
The next offset.
offset
\nint64
The offset.
prev_offset
\nint64
The previous offset.
total
\nint64
Total results.
type
\nstring
Offset type.
data
\n[object]
Team memberships response data
attributes
\nobject
Team membership attributes
provisioned_by
\nstring
The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.
provisioned_by_id
\nstring
UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.
role
\nenum
The user's role within the team \nAllowed enum values: admin
id [required]
\nstring
The ID of a user's relationship with a team
relationships
\nobject
Relationship between membership and a user
team
\nobject
Relationship between team membership and team
data [required]
\nobject
The team associated with the membership
id [required]
\nstring
The ID of the team associated with the membership
type [required]
\nenum
User team team type \nAllowed enum values: team
default: team
user
\nobject
Relationship between team membership and user
data [required]
\nobject
A user's relationship with a team
id [required]
\nstring
The ID of the user associated with the team
type [required]
\nenum
User team user type \nAllowed enum values: users
default: users
type [required]
\nenum
Team membership type \nAllowed enum values: team_memberships
default: team_memberships
included
\n[ <oneOf>]
Resources related to the team memberships
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
A team
attributes [required]
\nobject
Team attributes
avatar
\nstring
Unicode representation of the avatar for the team, limited to a single grapheme
banner
\nint64
Banner selection for the team
created_at
\ndate-time
Creation date of the team
description
\nstring
Free-form markdown description/content for the team's homepage
handle [required]
\nstring
The team's identifier
hidden_modules
\n[string]
Collection of hidden modules for the team
link_count
\nint32
The number of links belonging to the team
modified_at
\ndate-time
Modification date of the team
name [required]
\nstring
The name of the team
summary
\nstring
A brief summary of the team, derived from the description
user_count
\nint32
The number of users belonging to the team
visible_modules
\n[string]
Collection of visible modules for the team
id [required]
\nstring
The team's identifier
relationships
\nobject
Resources related to a team
team_links
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
user_team_permissions
\nobject
Relationship between a user team permission and a team
data
\nobject
Related user team permission data
id [required]
\nstring
The ID of the user team permission
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Links attributes.
related
\nstring
Related link.
type [required]
\nenum
Team type \nAllowed enum values: team
default: team
links
\nobject
Teams response links.
first
\nstring
First link.
last
\nstring
Last link.
next
\nstring
Next link.
prev
\nstring
Previous link.
self
\nstring
Current link.
meta
\nobject
Teams response metadata.
pagination
\nobject
Teams response metadata.
first_offset
\nint64
The first offset.
last_offset
\nint64
The last offset.
limit
\nint64
Pagination limit.
next_offset
\nint64
The next offset.
offset
\nint64
The offset.
prev_offset
\nint64
The previous offset.
total
\nint64
Total results.
type
\nstring
Offset type.
data
\nobject
A user's relationship with a team
attributes
\nobject
Team membership attributes
provisioned_by
\nstring
The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.
provisioned_by_id
\nstring
UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.
role
\nenum
The user's role within the team \nAllowed enum values: admin
id [required]
\nstring
The ID of a user's relationship with a team
relationships
\nobject
Relationship between membership and a user
team
\nobject
Relationship between team membership and team
data [required]
\nobject
The team associated with the membership
id [required]
\nstring
The ID of the team associated with the membership
type [required]
\nenum
User team team type \nAllowed enum values: team
default: team
user
\nobject
Relationship between team membership and user
data [required]
\nobject
A user's relationship with a team
id [required]
\nstring
The ID of the user associated with the team
type [required]
\nenum
User team user type \nAllowed enum values: users
default: users
type [required]
\nenum
Team membership type \nAllowed enum values: team_memberships
default: team_memberships
included
\n[ <oneOf>]
Resources related to the team memberships
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
A team
attributes [required]
\nobject
Team attributes
avatar
\nstring
Unicode representation of the avatar for the team, limited to a single grapheme
banner
\nint64
Banner selection for the team
created_at
\ndate-time
Creation date of the team
description
\nstring
Free-form markdown description/content for the team's homepage
handle [required]
\nstring
The team's identifier
hidden_modules
\n[string]
Collection of hidden modules for the team
link_count
\nint32
The number of links belonging to the team
modified_at
\ndate-time
Modification date of the team
name [required]
\nstring
The name of the team
summary
\nstring
A brief summary of the team, derived from the description
user_count
\nint32
The number of users belonging to the team
visible_modules
\n[string]
Collection of visible modules for the team
id [required]
\nstring
The team's identifier
relationships
\nobject
Resources related to a team
team_links
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
user_team_permissions
\nobject
Relationship between a user team permission and a team
data
\nobject
Related user team permission data
id [required]
\nstring
The ID of the user team permission
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Links attributes.
related
\nstring
Related link.
type [required]
\nenum
Team type \nAllowed enum values: team
default: team
data
\nobject
A user's relationship with a team
attributes
\nobject
Team membership attributes
provisioned_by
\nstring
The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.
provisioned_by_id
\nstring
UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.
role
\nenum
The user's role within the team \nAllowed enum values: admin
id [required]
\nstring
The ID of a user's relationship with a team
relationships
\nobject
Relationship between membership and a user
team
\nobject
Relationship between team membership and team
data [required]
\nobject
The team associated with the membership
id [required]
\nstring
The ID of the team associated with the membership
type [required]
\nenum
User team team type \nAllowed enum values: team
default: team
user
\nobject
Relationship between team membership and user
data [required]
\nobject
A user's relationship with a team
id [required]
\nstring
The ID of the user associated with the team
type [required]
\nenum
User team user type \nAllowed enum values: users
default: users
type [required]
\nenum
Team membership type \nAllowed enum values: team_memberships
default: team_memberships
included
\n[ <oneOf>]
Resources related to the team memberships
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
A team
attributes [required]
\nobject
Team attributes
avatar
\nstring
Unicode representation of the avatar for the team, limited to a single grapheme
banner
\nint64
Banner selection for the team
created_at
\ndate-time
Creation date of the team
description
\nstring
Free-form markdown description/content for the team's homepage
handle [required]
\nstring
The team's identifier
hidden_modules
\n[string]
Collection of hidden modules for the team
link_count
\nint32
The number of links belonging to the team
modified_at
\ndate-time
Modification date of the team
name [required]
\nstring
The name of the team
summary
\nstring
A brief summary of the team, derived from the description
user_count
\nint32
The number of users belonging to the team
visible_modules
\n[string]
Collection of visible modules for the team
id [required]
\nstring
The team's identifier
relationships
\nobject
Resources related to a team
team_links
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
user_team_permissions
\nobject
Relationship between a user team permission and a team
data
\nobject
Related user team permission data
id [required]
\nstring
The ID of the user team permission
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Links attributes.
related
\nstring
Related link.
type [required]
\nenum
Team type \nAllowed enum values: team
default: team
data
\nobject
A user's relationship with a team
attributes
\nobject
Team membership attributes
provisioned_by
\nstring
The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.
provisioned_by_id
\nstring
UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.
role
\nenum
The user's role within the team \nAllowed enum values: admin
id [required]
\nstring
The ID of a user's relationship with a team
relationships
\nobject
Relationship between membership and a user
team
\nobject
Relationship between team membership and team
data [required]
\nobject
The team associated with the membership
id [required]
\nstring
The ID of the team associated with the membership
type [required]
\nenum
User team team type \nAllowed enum values: team
default: team
user
\nobject
Relationship between team membership and user
data [required]
\nobject
A user's relationship with a team
id [required]
\nstring
The ID of the user associated with the team
type [required]
\nenum
User team user type \nAllowed enum values: users
default: users
type [required]
\nenum
Team membership type \nAllowed enum values: team_memberships
default: team_memberships
included
\n[ <oneOf>]
Resources related to the team memberships
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
A team
attributes [required]
\nobject
Team attributes
avatar
\nstring
Unicode representation of the avatar for the team, limited to a single grapheme
banner
\nint64
Banner selection for the team
created_at
\ndate-time
Creation date of the team
description
\nstring
Free-form markdown description/content for the team's homepage
handle [required]
\nstring
The team's identifier
hidden_modules
\n[string]
Collection of hidden modules for the team
link_count
\nint32
The number of links belonging to the team
modified_at
\ndate-time
Modification date of the team
name [required]
\nstring
The name of the team
summary
\nstring
A brief summary of the team, derived from the description
user_count
\nint32
The number of users belonging to the team
visible_modules
\n[string]
Collection of visible modules for the team
id [required]
\nstring
The team's identifier
relationships
\nobject
Resources related to a team
team_links
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
user_team_permissions
\nobject
Relationship between a user team permission and a team
data
\nobject
Related user team permission data
id [required]
\nstring
The ID of the user team permission
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Links attributes.
related
\nstring
Related link.
type [required]
\nenum
Team type \nAllowed enum values: team
default: team
data
\nobject
A user's relationship with a team
attributes
\nobject
Team membership attributes
provisioned_by
\nstring
The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.
provisioned_by_id
\nstring
UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.
role
\nenum
The user's role within the team \nAllowed enum values: admin
id [required]
\nstring
The ID of a user's relationship with a team
relationships
\nobject
Relationship between membership and a user
team
\nobject
Relationship between team membership and team
data [required]
\nobject
The team associated with the membership
id [required]
\nstring
The ID of the team associated with the membership
type [required]
\nenum
User team team type \nAllowed enum values: team
default: team
user
\nobject
Relationship between team membership and user
data [required]
\nobject
A user's relationship with a team
id [required]
\nstring
The ID of the user associated with the team
type [required]
\nenum
User team user type \nAllowed enum values: users
default: users
type [required]
\nenum
Team membership type \nAllowed enum values: team_memberships
default: team_memberships
included
\n[ <oneOf>]
Resources related to the team memberships
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
A team
attributes [required]
\nobject
Team attributes
avatar
\nstring
Unicode representation of the avatar for the team, limited to a single grapheme
banner
\nint64
Banner selection for the team
created_at
\ndate-time
Creation date of the team
description
\nstring
Free-form markdown description/content for the team's homepage
handle [required]
\nstring
The team's identifier
hidden_modules
\n[string]
Collection of hidden modules for the team
link_count
\nint32
The number of links belonging to the team
modified_at
\ndate-time
Modification date of the team
name [required]
\nstring
The name of the team
summary
\nstring
A brief summary of the team, derived from the description
user_count
\nint32
The number of users belonging to the team
visible_modules
\n[string]
Collection of visible modules for the team
id [required]
\nstring
The team's identifier
relationships
\nobject
Resources related to a team
team_links
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
user_team_permissions
\nobject
Relationship between a user team permission and a team
data
\nobject
Related user team permission data
id [required]
\nstring
The ID of the user team permission
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Links attributes.
related
\nstring
Related link.
type [required]
\nenum
Team type \nAllowed enum values: team
default: team
data
\n[object]
Team memberships response data
attributes
\nobject
Team membership attributes
provisioned_by
\nstring
The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.
provisioned_by_id
\nstring
UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.
role
\nenum
The user's role within the team \nAllowed enum values: admin
id [required]
\nstring
The ID of a user's relationship with a team
relationships
\nobject
Relationship between membership and a user
team
\nobject
Relationship between team membership and team
data [required]
\nobject
The team associated with the membership
id [required]
\nstring
The ID of the team associated with the membership
type [required]
\nenum
User team team type \nAllowed enum values: team
default: team
user
\nobject
Relationship between team membership and user
data [required]
\nobject
A user's relationship with a team
id [required]
\nstring
The ID of the user associated with the team
type [required]
\nenum
User team user type \nAllowed enum values: users
default: users
type [required]
\nenum
Team membership type \nAllowed enum values: team_memberships
default: team_memberships
included
\n[ <oneOf>]
Resources related to the team memberships
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
A team
attributes [required]
\nobject
Team attributes
avatar
\nstring
Unicode representation of the avatar for the team, limited to a single grapheme
banner
\nint64
Banner selection for the team
created_at
\ndate-time
Creation date of the team
description
\nstring
Free-form markdown description/content for the team's homepage
handle [required]
\nstring
The team's identifier
hidden_modules
\n[string]
Collection of hidden modules for the team
link_count
\nint32
The number of links belonging to the team
modified_at
\ndate-time
Modification date of the team
name [required]
\nstring
The name of the team
summary
\nstring
A brief summary of the team, derived from the description
user_count
\nint32
The number of users belonging to the team
visible_modules
\n[string]
Collection of visible modules for the team
id [required]
\nstring
The team's identifier
relationships
\nobject
Resources related to a team
team_links
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
user_team_permissions
\nobject
Relationship between a user team permission and a team
data
\nobject
Related user team permission data
id [required]
\nstring
The ID of the user team permission
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Links attributes.
related
\nstring
Related link.
type [required]
\nenum
Team type \nAllowed enum values: team
default: team
links
\nobject
Teams response links.
first
\nstring
First link.
last
\nstring
Last link.
next
\nstring
Next link.
prev
\nstring
Previous link.
self
\nstring
Current link.
meta
\nobject
Teams response metadata.
pagination
\nobject
Teams response metadata.
first_offset
\nint64
The first offset.
last_offset
\nint64
The last offset.
limit
\nint64
Pagination limit.
next_offset
\nint64
The next offset.
offset
\nint64
The offset.
prev_offset
\nint64
The previous offset.
total
\nint64
Total results.
type
\nstring
Offset type.
data
\n[object]
Team memberships response data
attributes
\nobject
Team membership attributes
provisioned_by
\nstring
The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.
provisioned_by_id
\nstring
UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.
role
\nenum
The user's role within the team \nAllowed enum values: admin
id [required]
\nstring
The ID of a user's relationship with a team
relationships
\nobject
Relationship between membership and a user
team
\nobject
Relationship between team membership and team
data [required]
\nobject
The team associated with the membership
id [required]
\nstring
The ID of the team associated with the membership
type [required]
\nenum
User team team type \nAllowed enum values: team
default: team
user
\nobject
Relationship between team membership and user
data [required]
\nobject
A user's relationship with a team
id [required]
\nstring
The ID of the user associated with the team
type [required]
\nenum
User team user type \nAllowed enum values: users
default: users
type [required]
\nenum
Team membership type \nAllowed enum values: team_memberships
default: team_memberships
included
\n[ <oneOf>]
Resources related to the team memberships
Option 1
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 2
\nobject
A team
attributes [required]
\nobject
Team attributes
avatar
\nstring
Unicode representation of the avatar for the team, limited to a single grapheme
banner
\nint64
Banner selection for the team
created_at
\ndate-time
Creation date of the team
description
\nstring
Free-form markdown description/content for the team's homepage
handle [required]
\nstring
The team's identifier
hidden_modules
\n[string]
Collection of hidden modules for the team
link_count
\nint32
The number of links belonging to the team
modified_at
\ndate-time
Modification date of the team
name [required]
\nstring
The name of the team
summary
\nstring
A brief summary of the team, derived from the description
user_count
\nint32
The number of users belonging to the team
visible_modules
\n[string]
Collection of visible modules for the team
id [required]
\nstring
The team's identifier
relationships
\nobject
Resources related to a team
team_links
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
user_team_permissions
\nobject
Relationship between a user team permission and a team
data
\nobject
Related user team permission data
id [required]
\nstring
The ID of the user team permission
type [required]
\nenum
User team permission type \nAllowed enum values: user_team_permissions
default: user_team_permissions
links
\nobject
Links attributes.
related
\nstring
Related link.
type [required]
\nenum
Team type \nAllowed enum values: team
default: team
links
\nobject
Teams response links.
first
\nstring
First link.
last
\nstring
Last link.
next
\nstring
Next link.
prev
\nstring
Previous link.
self
\nstring
Current link.
meta
\nobject
Teams response metadata.
pagination
\nobject
Teams response metadata.
first_offset
\nint64
The first offset.
last_offset
\nint64
The last offset.
limit
\nint64
Pagination limit.
next_offset
\nint64
The next offset.
offset
\nint64
The offset.
prev_offset
\nint64
The previous offset.
total
\nint64
Total results.
type
\nstring
Offset type.
data
\n[object]
Array of returned users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the users.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
meta
\nobject
Object describing meta attributes of response.
page
\nobject
Pagination object.
total_count
\nint64
Total count.
total_filtered_count
\nint64
Total count of elements matched by the filter.
data
\n[object]
Array of returned users.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the users.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
meta
\nobject
Object describing meta attributes of response.
page
\nobject
Pagination object.
total_count
\nint64
Total count.
total_filtered_count
\nint64
Total count of elements matched by the filter.
data
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the user.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
data
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the user.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
data
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the user.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
data
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the user.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
data
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the user.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
data
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the user.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
data
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the user.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles
data
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
Creation time of the user.
disabled
\nboolean
Whether the user is disabled.
string
Email of the user.
handle
\nstring
Handle of the user.
icon
\nstring
URL of the user's icon.
last_login_time
\ndate-time
The last time the user logged in.
mfa_enabled
\nboolean
If user has MFA enabled.
modified_at
\ndate-time
Time that the user was last modified.
name
\nstring
Name of the user.
service_account
\nboolean
Whether the user is a service account.
status
\nstring
Status of the user.
title
\nstring
Title of the user.
verified
\nboolean
Whether the user is verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
included
\n[ <oneOf>]
Array of objects related to the user.
Option 1
\nobject
Organization object.
attributes
\nobject
Attributes of the organization.
created_at
\ndate-time
Creation time of the organization.
description
\nstring
Description of the organization.
disabled
\nboolean
Whether or not the organization is disabled.
modified_at
\ndate-time
Time of last organization modification.
name
\nstring
Name of the organization.
public_id
\nstring
Public ID of the organization.
sharing
\nstring
Sharing type of the organization.
url
\nstring
URL of the site that this organization exists at.
id
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
Option 2
\nobject
Permission object.
attributes
\nobject
Attributes of a permission.
created
\ndate-time
Creation time of the permission.
description
\nstring
Description of the permission.
display_name
\nstring
Displayed name for the permission.
display_type
\nstring
Display type.
group_name
\nstring
Name of the permission group.
name
\nstring
Name of the permission.
restricted
\nboolean
Whether or not the permission is restricted.
id
\nstring
ID of the permission.
type [required]
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
Option 3
\nobject
Role object returned by the API.
attributes
\nobject
Attributes of the role.
created_at
\ndate-time
Creation time of the role.
modified_at
\ndate-time
Time of last role modification.
name
\nstring
The name of the role. The name is neither unique nor a stable identifier of the role.
user_count
\nint64
Number of users with that role.
id
\nstring
The unique identifier of the role.
relationships
\nobject
Relationships of the role object returned by the API.
permissions
\nobject
Relationship to multiple permissions objects.
data
\n[object]
Relationships to permission objects.
id
\nstring
ID of the permission.
type
\nenum
Permissions resource type. \nAllowed enum values: permissions
default: permissions
type [required]
\nenum
Roles type. \nAllowed enum values: roles
default: roles