Safe Haskell	None
Language	Haskell2010

Network.PagerDuty.REST.Users

Contents

List Users
List On Call Users
Create User
Get User
Get User On Call
Update User
Delete User
Types

Description

Access and manipulate user data for your PagerDuty account. When a user is shown inlined in other resources, a deleted user will have its html_url attribute set to null.

See: http://developer.pagerduty.com/documentation/rest/users

Synopsis

List Users

data ListUsers Source

Instances

ToJSON ListUsers Source
Generic ListUsers Source
HasDatatypeInfo ListUsers Source
QueryLike ListUsers Source
Paginate ListUsers Source
type Code ListUsers = (:) [] ((:) (Maybe Text) ([] )) ([] []) Source

listUsers :: Request ListUsers s [User] Source

List users of your PagerDuty account, optionally filtered by a search query.

GET /users

See: http://developer.pagerduty.com/documentation/rest/users/list

luQuery :: Lens' (Request ListUsers s b) (Maybe Text) Source

Filters the result, showing only the users whose names or email addresses match the query.

List On Call Users

listOnCallUsers :: Request ListUsers s [User] Source

List all the existing escalation policies with currently on-call users.

If the start and end of an on-call object are null, then the user is always on-call for an escalation policy level.

GET /escalation_policies/on_call

See: http://developer.pagerduty.com/documentation/rest/escalation_policies/on_call

Create User

data CreateUser Source

Instances

Eq CreateUser Source
Show CreateUser Source
ToJSON CreateUser Source
FromJSON CreateUser Source
QueryLike CreateUser Source

createUser Source

Arguments

:: RequesterId
-> Text	`cuName`
-> Address	`cuEmail`
-> Request CreateUser s User

Create a new user for your account. An invite email will be sent asking the user to choose a password.

POST /users

See: http://developer.pagerduty.com/documentation/rest/users/create

cuName :: Lens' (Request CreateUser s b) Text Source

The name of the user.

cuEmail :: Lens' (Request CreateUser s b) Address Source

The email of the user. The newly created user will receive an email asking to confirm the subscription.

cuRole :: Lens' (Request CreateUser s b) (Maybe Role) Source

The user's role.

cuJobTitle :: Lens' (Request CreateUser s b) (Maybe Text) Source

The job title of the user.

cuTimeZone :: Lens' (Request CreateUser s b) (Maybe TimeZone) Source

The time zone the user is in. If not specified, the time zone of the account making the API call will be used.

Get User

getUser :: UserId -> Request Empty s User Source

Get information about an existing user.

GET /users/:id

See: http://developer.pagerduty.com/documentation/rest/users/show

Get User On Call

getUserOnCall :: UserId -> Request Empty s User Source

Get a user object with that user's current on-call status. If the on-call object is an empty list, the user is never on-call.

If the start and end of an on-call object are null, then the user is always on-call for an escalation policy level.

GET /users/:id/on_call

See: http://developer.pagerduty.com/documentation/rest/users/show_on_call

Update User

data UpdateUser Source

Instances

Eq UpdateUser Source
Show UpdateUser Source
ToJSON UpdateUser Source
FromJSON UpdateUser Source
QueryLike UpdateUser Source

updateUser :: UserId -> Request UpdateUser s User Source

Update an existing user.

PUT /users/:id

See: http://developer.pagerduty.com/documentation/rest/users/update

uuName :: Lens' (Request UpdateUser s b) (Maybe Text) Source

The name of the user.

uuEmail :: Lens' (Request UpdateUser s b) (Maybe Address) Source

The email of the user. The newly created user will receive an email asking to confirm the subscription.

uuRole :: Lens' (Request UpdateUser s b) (Maybe Role) Source

The user's role.

uuJobTitle :: Lens' (Request UpdateUser s b) (Maybe Text) Source

The job title of the user.

uuTimeZone :: Lens' (Request UpdateUser s b) (Maybe TimeZone) Source

The time zone the user is in. If not specified, the time zone of the account making the API call will be used.

Delete User

deleteUser :: UserId -> Request Empty s Empty Source

Remove an existing user.

DELETE /users/:id

See: http://developer.pagerduty.com/documentation/rest/users/delete

Types

data PolicyInfo Source

Instances

Eq PolicyInfo Source
Show PolicyInfo Source
ToJSON PolicyInfo Source
FromJSON PolicyInfo Source

piId :: Lens' PolicyInfo EscalationPolicyId Source

piName :: Lens' PolicyInfo Text Source

data OnCall Source

Instances

Eq OnCall Source
Show OnCall Source
ToJSON OnCall Source
FromJSON OnCall Source

ocLevel :: Lens' OnCall Int Source

ocStart :: Lens' OnCall (Maybe Date) Source

ocEnd :: Lens' OnCall (Maybe Date) Source

ocEscalationPolicy :: Lens' OnCall PolicyInfo Source

data Role Source

Constructors

RoleAdmin
RoleUser
RoleLimitedUser

Instances

Eq Role Source
Show Role Source
ToJSON Role Source
FromJSON Role Source
Default Role Source

class HasUserInfo a where Source

Minimal complete definition

userInfo

Methods

userInfo :: Lens' a UserInfo Source

uId :: Lens' a UserId Source

The id of the user.

uName :: Lens' a Text Source

The name of the user.

uEmail :: Lens' a Address Source

The user's email address.

uColor :: Lens' a Text Source

The color used to represent the user in schedules.

uTimeZone :: Lens' a TimeZone Source

The user's personal time zone.

Instances

HasUserInfo UserInfo Source
HasUserInfo User Source
HasUserInfo Override Source
(QueryLike a, ToJSON a, HasUserInfo a) => HasUserInfo (Request a s b) Source

data UserInfo Source

Instances

Eq UserInfo Source
Show UserInfo Source
ToJSON UserInfo Source
FromJSON UserInfo Source
HasUserInfo UserInfo Source

data User Source

Instances

Eq User Source
Show User Source
ToJSON User Source
FromJSON User Source
HasUserInfo User Source

uRole :: Lens' User Role Source

uAvatarUrl :: Lens' User Text Source

uUserUrl :: Lens' User Text Source

uInvitationSent :: Lens' User Bool Source

uJobTitle :: Lens' User (Maybe Text) Source