1. Docs
  2. Reference
  3. API
  4. PagerDuty
  5. User

User

A user is a member of a PagerDuty account that have the ability to interact with incidents and other data on the account.

Example Usage

using Pulumi;
using Pagerduty = Pulumi.Pagerduty;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Pagerduty.User("example", new Pagerduty.UserArgs
        {
            Email = "125.greenholt.earline@graham.name",
        });
    }

}

package main

import (
	"github.com/pulumi/pulumi-pagerduty/sdk/v2/go/pagerduty"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := pagerduty.NewUser(ctx, "example", &pagerduty.UserArgs{
			Email: pulumi.String("125.greenholt.earline@graham.name"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

import pulumi
import pulumi_pagerduty as pagerduty

example = pagerduty.User("example", email="125.greenholt.earline@graham.name")

import * as pulumi from "@pulumi/pulumi";
import * as pagerduty from "@pulumi/pagerduty";

const example = new pagerduty.User("example", {
    email: "125.greenholt.earline@graham.name",
});

Create a User Resource

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         color: Optional[str] = None,
         description: Optional[str] = None,
         email: Optional[str] = None,
         job_title: Optional[str] = None,
         name: Optional[str] = None,
         role: Optional[str] = None,
         teams: Optional[Sequence[str]] = None,
         time_zone: Optional[str] = None)
@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)
func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

User Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The User resource accepts the following input properties:

Email string
The user’s email address.
Color string
The schedule color for the user. Valid options are purple, red, green, blue, teal, orange, brown, turquoise, dark-slate-blue, cayenne, orange-red, dark-orchid, dark-slate-grey, lime, dark-magenta, lime-green, midnight-blue, deep-pink, dark-green, dark-orange, dark-cyan, darkolive-green, dark-slate-gray, grey20, firebrick, maroon, crimson, dark-red, dark-goldenrod, chocolate, medium-violet-red, sea-green, olivedrab, forest-green, dark-olive-green, blue-violet, royal-blue, indigo, slate-blue, saddle-brown, or steel-blue.
Description string
JobTitle string
The user’s title.
Name string
The name of the user.
Role string
The user role. Account must have the read_only_users ability to set a user as a read_only_user or a read_only_limited_user, and must have advanced permissions abilities to set a user as observer or restricted_access. Can be admin, limited_user, observer, owner, read_only_user, read_only_limited_user, restricted_access, or user.
Teams List<string>
A list of teams the user should belong to. Please use pagerduty.TeamMembership instead.

Deprecated: Use the ‘pagerduty_team_membership’ resource instead.

TimeZone string
The time zone of the user. Default is account default timezone.
Email string
The user’s email address.
Color string
The schedule color for the user. Valid options are purple, red, green, blue, teal, orange, brown, turquoise, dark-slate-blue, cayenne, orange-red, dark-orchid, dark-slate-grey, lime, dark-magenta, lime-green, midnight-blue, deep-pink, dark-green, dark-orange, dark-cyan, darkolive-green, dark-slate-gray, grey20, firebrick, maroon, crimson, dark-red, dark-goldenrod, chocolate, medium-violet-red, sea-green, olivedrab, forest-green, dark-olive-green, blue-violet, royal-blue, indigo, slate-blue, saddle-brown, or steel-blue.
Description string
JobTitle string
The user’s title.
Name string
The name of the user.
Role string
The user role. Account must have the read_only_users ability to set a user as a read_only_user or a read_only_limited_user, and must have advanced permissions abilities to set a user as observer or restricted_access. Can be admin, limited_user, observer, owner, read_only_user, read_only_limited_user, restricted_access, or user.
Teams []string
A list of teams the user should belong to. Please use pagerduty.TeamMembership instead.

Deprecated: Use the ‘pagerduty_team_membership’ resource instead.

TimeZone string
The time zone of the user. Default is account default timezone.
email string
The user’s email address.
color string
The schedule color for the user. Valid options are purple, red, green, blue, teal, orange, brown, turquoise, dark-slate-blue, cayenne, orange-red, dark-orchid, dark-slate-grey, lime, dark-magenta, lime-green, midnight-blue, deep-pink, dark-green, dark-orange, dark-cyan, darkolive-green, dark-slate-gray, grey20, firebrick, maroon, crimson, dark-red, dark-goldenrod, chocolate, medium-violet-red, sea-green, olivedrab, forest-green, dark-olive-green, blue-violet, royal-blue, indigo, slate-blue, saddle-brown, or steel-blue.
description string
jobTitle string
The user’s title.
name string
The name of the user.
role string
The user role. Account must have the read_only_users ability to set a user as a read_only_user or a read_only_limited_user, and must have advanced permissions abilities to set a user as observer or restricted_access. Can be admin, limited_user, observer, owner, read_only_user, read_only_limited_user, restricted_access, or user.
teams string[]
A list of teams the user should belong to. Please use pagerduty.TeamMembership instead.

Deprecated: Use the ‘pagerduty_team_membership’ resource instead.

timeZone string
The time zone of the user. Default is account default timezone.
email str
The user’s email address.
color str
The schedule color for the user. Valid options are purple, red, green, blue, teal, orange, brown, turquoise, dark-slate-blue, cayenne, orange-red, dark-orchid, dark-slate-grey, lime, dark-magenta, lime-green, midnight-blue, deep-pink, dark-green, dark-orange, dark-cyan, darkolive-green, dark-slate-gray, grey20, firebrick, maroon, crimson, dark-red, dark-goldenrod, chocolate, medium-violet-red, sea-green, olivedrab, forest-green, dark-olive-green, blue-violet, royal-blue, indigo, slate-blue, saddle-brown, or steel-blue.
description str
job_title str
The user’s title.
name str
The name of the user.
role str
The user role. Account must have the read_only_users ability to set a user as a read_only_user or a read_only_limited_user, and must have advanced permissions abilities to set a user as observer or restricted_access. Can be admin, limited_user, observer, owner, read_only_user, read_only_limited_user, restricted_access, or user.
teams Sequence[str]
A list of teams the user should belong to. Please use pagerduty.TeamMembership instead.

Deprecated: Use the ‘pagerduty_team_membership’ resource instead.

time_zone str
The time zone of the user. Default is account default timezone.

Outputs

All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

AvatarUrl string
The URL of the user’s avatar.
HtmlUrl string
URL at which the entity is uniquely displayed in the Web app
Id string
The provider-assigned unique ID for this managed resource.
InvitationSent bool
If true, the user has an outstanding invitation.
AvatarUrl string
The URL of the user’s avatar.
HtmlUrl string
URL at which the entity is uniquely displayed in the Web app
Id string
The provider-assigned unique ID for this managed resource.
InvitationSent bool
If true, the user has an outstanding invitation.
avatarUrl string
The URL of the user’s avatar.
htmlUrl string
URL at which the entity is uniquely displayed in the Web app
id string
The provider-assigned unique ID for this managed resource.
invitationSent boolean
If true, the user has an outstanding invitation.
avatar_url str
The URL of the user’s avatar.
html_url str
URL at which the entity is uniquely displayed in the Web app
id str
The provider-assigned unique ID for this managed resource.
invitation_sent bool
If true, the user has an outstanding invitation.

Look up an Existing User Resource

Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        avatar_url: Optional[str] = None,
        color: Optional[str] = None,
        description: Optional[str] = None,
        email: Optional[str] = None,
        html_url: Optional[str] = None,
        invitation_sent: Optional[bool] = None,
        job_title: Optional[str] = None,
        name: Optional[str] = None,
        role: Optional[str] = None,
        teams: Optional[Sequence[str]] = None,
        time_zone: Optional[str] = None) -> User
func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AvatarUrl string
The URL of the user’s avatar.
Color string
The schedule color for the user. Valid options are purple, red, green, blue, teal, orange, brown, turquoise, dark-slate-blue, cayenne, orange-red, dark-orchid, dark-slate-grey, lime, dark-magenta, lime-green, midnight-blue, deep-pink, dark-green, dark-orange, dark-cyan, darkolive-green, dark-slate-gray, grey20, firebrick, maroon, crimson, dark-red, dark-goldenrod, chocolate, medium-violet-red, sea-green, olivedrab, forest-green, dark-olive-green, blue-violet, royal-blue, indigo, slate-blue, saddle-brown, or steel-blue.
Description string
Email string
The user’s email address.
HtmlUrl string
URL at which the entity is uniquely displayed in the Web app
InvitationSent bool
If true, the user has an outstanding invitation.
JobTitle string
The user’s title.
Name string
The name of the user.
Role string
The user role. Account must have the read_only_users ability to set a user as a read_only_user or a read_only_limited_user, and must have advanced permissions abilities to set a user as observer or restricted_access. Can be admin, limited_user, observer, owner, read_only_user, read_only_limited_user, restricted_access, or user.
Teams List<string>
A list of teams the user should belong to. Please use pagerduty.TeamMembership instead.

Deprecated: Use the ‘pagerduty_team_membership’ resource instead.

TimeZone string
The time zone of the user. Default is account default timezone.
AvatarUrl string
The URL of the user’s avatar.
Color string
The schedule color for the user. Valid options are purple, red, green, blue, teal, orange, brown, turquoise, dark-slate-blue, cayenne, orange-red, dark-orchid, dark-slate-grey, lime, dark-magenta, lime-green, midnight-blue, deep-pink, dark-green, dark-orange, dark-cyan, darkolive-green, dark-slate-gray, grey20, firebrick, maroon, crimson, dark-red, dark-goldenrod, chocolate, medium-violet-red, sea-green, olivedrab, forest-green, dark-olive-green, blue-violet, royal-blue, indigo, slate-blue, saddle-brown, or steel-blue.
Description string
Email string
The user’s email address.
HtmlUrl string
URL at which the entity is uniquely displayed in the Web app
InvitationSent bool
If true, the user has an outstanding invitation.
JobTitle string
The user’s title.
Name string
The name of the user.
Role string
The user role. Account must have the read_only_users ability to set a user as a read_only_user or a read_only_limited_user, and must have advanced permissions abilities to set a user as observer or restricted_access. Can be admin, limited_user, observer, owner, read_only_user, read_only_limited_user, restricted_access, or user.
Teams []string
A list of teams the user should belong to. Please use pagerduty.TeamMembership instead.

Deprecated: Use the ‘pagerduty_team_membership’ resource instead.

TimeZone string
The time zone of the user. Default is account default timezone.
avatarUrl string
The URL of the user’s avatar.
color string
The schedule color for the user. Valid options are purple, red, green, blue, teal, orange, brown, turquoise, dark-slate-blue, cayenne, orange-red, dark-orchid, dark-slate-grey, lime, dark-magenta, lime-green, midnight-blue, deep-pink, dark-green, dark-orange, dark-cyan, darkolive-green, dark-slate-gray, grey20, firebrick, maroon, crimson, dark-red, dark-goldenrod, chocolate, medium-violet-red, sea-green, olivedrab, forest-green, dark-olive-green, blue-violet, royal-blue, indigo, slate-blue, saddle-brown, or steel-blue.
description string
email string
The user’s email address.
htmlUrl string
URL at which the entity is uniquely displayed in the Web app
invitationSent boolean
If true, the user has an outstanding invitation.
jobTitle string
The user’s title.
name string
The name of the user.
role string
The user role. Account must have the read_only_users ability to set a user as a read_only_user or a read_only_limited_user, and must have advanced permissions abilities to set a user as observer or restricted_access. Can be admin, limited_user, observer, owner, read_only_user, read_only_limited_user, restricted_access, or user.
teams string[]
A list of teams the user should belong to. Please use pagerduty.TeamMembership instead.

Deprecated: Use the ‘pagerduty_team_membership’ resource instead.

timeZone string
The time zone of the user. Default is account default timezone.
avatar_url str
The URL of the user’s avatar.
color str
The schedule color for the user. Valid options are purple, red, green, blue, teal, orange, brown, turquoise, dark-slate-blue, cayenne, orange-red, dark-orchid, dark-slate-grey, lime, dark-magenta, lime-green, midnight-blue, deep-pink, dark-green, dark-orange, dark-cyan, darkolive-green, dark-slate-gray, grey20, firebrick, maroon, crimson, dark-red, dark-goldenrod, chocolate, medium-violet-red, sea-green, olivedrab, forest-green, dark-olive-green, blue-violet, royal-blue, indigo, slate-blue, saddle-brown, or steel-blue.
description str
email str
The user’s email address.
html_url str
URL at which the entity is uniquely displayed in the Web app
invitation_sent bool
If true, the user has an outstanding invitation.
job_title str
The user’s title.
name str
The name of the user.
role str
The user role. Account must have the read_only_users ability to set a user as a read_only_user or a read_only_limited_user, and must have advanced permissions abilities to set a user as observer or restricted_access. Can be admin, limited_user, observer, owner, read_only_user, read_only_limited_user, restricted_access, or user.
teams Sequence[str]
A list of teams the user should belong to. Please use pagerduty.TeamMembership instead.

Deprecated: Use the ‘pagerduty_team_membership’ resource instead.

time_zone str
The time zone of the user. Default is account default timezone.

Import

Users can be imported using the id, e.g.

 $ pulumi import pagerduty:index/user:User main PLBP09X

Package Details

Repository
https://github.com/pulumi/pulumi-pagerduty
License
Apache-2.0
Notes
This Pulumi package is based on the pagerduty Terraform Provider.
Register Now For PulumiUP