pagerduty-0.0.8: Client library for PagerDuty Integration and REST APIs.

Safe HaskellNone
LanguageHaskell2010

Network.PagerDuty.REST.Users

Contents

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 #

Instances

ToJSON ListUsers # 
Generic ListUsers # 

Associated Types

type Code ListUsers :: [[*]] #

HasDatatypeInfo ListUsers # 
QueryLike ListUsers # 

Methods

toQuery :: ListUsers -> Query #

Paginate ListUsers # 

Methods

next :: Request ListUsers s b -> Maybe Pager -> Maybe (Request ListUsers s b)

type Code ListUsers # 
type Code ListUsers = (:) [*] ((:) * (Maybe Text) ([] *)) ([] [*])
type DatatypeInfoOf ListUsers # 
type DatatypeInfoOf ListUsers = Newtype "Network.PagerDuty.REST.Users" "ListUsers" (Record "ListUsers" ((:) FieldInfo (FieldInfo "_luQuery'") ([] FieldInfo)))

listUsers :: Request ListUsers s [User] #

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) #

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

List On Call Users

listOnCallUsers :: Request ListUsers s [User] #

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

createUser #

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 #

The name of the user.

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

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) #

The user's role.

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

The job title of the user.

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

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 #

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 #

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

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

The name of the user.

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

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) #

The user's role.

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

The job title of the user.

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

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

Types

data Role #

Instances