1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Network.PagerDuty.REST.Users</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
2window.onload = function () {pageLoad();setSynopsis("mini_Network-PagerDuty-REST-Users.html");};
4</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">pagerduty-0.0.1.1: Client library for PagerDuty Integration and REST APIs.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Network.PagerDuty.REST.Users</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">List Users</a></li><li><a href="#g:2">List On Call Users</a></li><li><a href="#g:3">Create User</a></li><li><a href="#g:4">Get User</a></li><li><a href="#g:5">Get User On Call</a></li><li><a href="#g:6">Update User</a></li><li><a href="#g:7">Delete User</a></li><li><a href="#g:8">Types</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Access and manipulate user data for your PagerDuty account. When a user is
5 shown inlined in other resources, a deleted user will have its <code>html_url</code> attribute
6 set to null.</p><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/users">http://developer.pagerduty.com/documentation/rest/users</a></p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:ListUsers">ListUsers</a></li><li class="src short"><a href="#v:listUsers">listUsers</a> :: <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:ListUsers">ListUsers</a> s [<a href="Network-PagerDuty-REST-Users.html#t:User">User</a>]</li><li class="src short"><a href="#v:luQuery">luQuery</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:ListUsers">ListUsers</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li><li class="src short"><a href="#v:listOnCallUsers">listOnCallUsers</a> :: <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:ListUsers">ListUsers</a> s [<a href="Network-PagerDuty-REST-Users.html#t:User">User</a>]</li><li class="src short"><span class="keyword">data</span> <a href="#t:CreateUser">CreateUser</a></li><li class="src short"><a href="#v:createUser">createUser</a> :: <a href="Network-PagerDuty-Integration.html#t:RequesterId">RequesterId</a> -> Text -> <a href="Network-PagerDuty-Integration.html#t:Address">Address</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a> s <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></li><li class="src short"><a href="#v:cuName">cuName</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a> s b) Text</li><li class="src short"><a href="#v:cuEmail">cuEmail</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a> s b) <a href="Network-PagerDuty-Integration.html#t:Address">Address</a></li><li class="src short"><a href="#v:cuRole">cuRole</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-PagerDuty-REST-Users.html#t:Role">Role</a>)</li><li class="src short"><a href="#v:cuJobTitle">cuJobTitle</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li><li class="src short"><a href="#v:cuTimeZone">cuTimeZone</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> TimeZone)</li><li class="src short"><a href="#v:getUser">getUser</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></li><li class="src short"><a href="#v:getUserOnCall">getUserOnCall</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:UpdateUser">UpdateUser</a></li><li class="src short"><a href="#v:updateUser">updateUser</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a> s <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></li><li class="src short"><a href="#v:uuName">uuName</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li><li class="src short"><a href="#v:uuEmail">uuEmail</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-PagerDuty-Integration.html#t:Address">Address</a>)</li><li class="src short"><a href="#v:uuRole">uuRole</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-PagerDuty-REST-Users.html#t:Role">Role</a>)</li><li class="src short"><a href="#v:uuJobTitle">uuJobTitle</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li><li class="src short"><a href="#v:uuTimeZone">uuTimeZone</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> TimeZone)</li><li class="src short"><a href="#v:deleteUser">deleteUser</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:PolicyInfo">PolicyInfo</a></li><li class="src short"><a href="#v:piId">piId</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:PolicyInfo">PolicyInfo</a> <a href="Network-PagerDuty-Integration.html#t:EscalationPolicyId">EscalationPolicyId</a></li><li class="src short"><a href="#v:piName">piName</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:PolicyInfo">PolicyInfo</a> Text</li><li class="src short"><span class="keyword">data</span> <a href="#t:OnCall">OnCall</a></li><li class="src short"><a href="#v:ocLevel">ocLevel</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:OnCall">OnCall</a> <a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:ocStart">ocStart</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:OnCall">OnCall</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Date)</li><li class="src short"><a href="#v:ocEnd">ocEnd</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:OnCall">OnCall</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Date)</li><li class="src short"><a href="#v:ocEscalationPolicy">ocEscalationPolicy</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:OnCall">OnCall</a> <a href="Network-PagerDuty-REST-Users.html#t:PolicyInfo">PolicyInfo</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:Role">Role</a><ul class="subs"><li>= <a href="#v:RoleAdmin">RoleAdmin</a></li><li>| <a href="#v:RoleUser">RoleUser</a></li><li>| <a href="#v:RoleLimitedUser">RoleLimitedUser</a></li></ul></li><li class="src short"><span class="keyword">class</span> <a href="#t:HasUserInfo">HasUserInfo</a> a <span class="keyword">where</span><ul class="subs"><li><a href="#v:userInfo">userInfo</a> :: Lens' a <a href="Network-PagerDuty-REST-Users.html#t:UserInfo">UserInfo</a></li><li><a href="#v:uId">uId</a> :: Lens' a <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a></li><li><a href="#v:uName">uName</a> :: Lens' a Text</li><li><a href="#v:uEmail">uEmail</a> :: Lens' a <a href="Network-PagerDuty-Integration.html#t:Address">Address</a></li><li><a href="#v:uColor">uColor</a> :: Lens' a Text</li><li><a href="#v:uTimeZone">uTimeZone</a> :: Lens' a TimeZone</li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:UserInfo">UserInfo</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:User">User</a></li><li class="src short"><a href="#v:uRole">uRole</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:User">User</a> <a href="Network-PagerDuty-REST-Users.html#t:Role">Role</a></li><li class="src short"><a href="#v:uAvatarUrl">uAvatarUrl</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:User">User</a> Text</li><li class="src short"><a href="#v:uUserUrl">uUserUrl</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:User">User</a> Text</li><li class="src short"><a href="#v:uInvitationSent">uInvitationSent</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:User">User</a> <a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:uJobTitle">uJobTitle</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:User">User</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li></ul></div><div id="interface"><h1 id="g:1">List Users</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ListUsers" class="def">ListUsers</a></p><div class="subs instances"><p id="control.i:ListUsers" class="caption collapser" onclick="toggleSection('i:ListUsers')">Instances</p><div id="section.i:ListUsers" class="show"><table><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Users.html#t:ListUsers">ListUsers</a></td><td class="doc empty"> </td></tr><tr><td class="src">HasDatatypeInfo <a href="Network-PagerDuty-REST-Users.html#t:ListUsers">ListUsers</a></td><td class="doc empty"> </td></tr><tr><td class="src">Generic <a href="Network-PagerDuty-REST-Users.html#t:ListUsers">ListUsers</a></td><td class="doc empty"> </td></tr><tr><td class="src">QueryLike <a href="Network-PagerDuty-REST-Users.html#t:ListUsers">ListUsers</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Network-PagerDuty-Integration.html#t:Paginate">Paginate</a> <a href="Network-PagerDuty-REST-Users.html#t:ListUsers">ListUsers</a></td><td class="doc empty"> </td></tr><tr><td class="src"><span class="keyword">type</span> Code <a href="Network-PagerDuty-REST-Users.html#t:ListUsers">ListUsers</a> = (:) [*] ((:) * (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Text) ([] *)) ([] [*])</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:listUsers" class="def">listUsers</a> :: <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:ListUsers">ListUsers</a> s [<a href="Network-PagerDuty-REST-Users.html#t:User">User</a>]</p><div class="doc"><p>List users of your PagerDuty account, optionally filtered by a search query.</p><pre>GET /users</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/users/list">http://developer.pagerduty.com/documentation/rest/users/list</a></p></div></div><div class="top"><p class="src"><a name="v:luQuery" class="def">luQuery</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:ListUsers">ListUsers</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Text)</p><div class="doc"><p>Filters the result, showing only the users whose names or email addresses
7 match the query.</p></div></div><h1 id="g:2">List On Call Users</h1><div class="top"><p class="src"><a name="v:listOnCallUsers" class="def">listOnCallUsers</a> :: <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:ListUsers">ListUsers</a> s [<a href="Network-PagerDuty-REST-Users.html#t:User">User</a>]</p><div class="doc"><p>List all the existing escalation policies with currently on-call users.</p><p>If the start and end of an on-call object are null, then the user is always
8 on-call for an escalation policy level.</p><pre>GET /escalation_policies/on_call</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/escalation_policies/on_call">http://developer.pagerduty.com/documentation/rest/escalation_policies/on_call</a></p></div></div><h1 id="g:3">Create User</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CreateUser" class="def">CreateUser</a></p><div class="subs instances"><p id="control.i:CreateUser" class="caption collapser" onclick="toggleSection('i:CreateUser')">Instances</p><div id="section.i:CreateUser" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a></td><td class="doc empty"> </td></tr><tr><td class="src">QueryLike <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:createUser" class="def">createUser</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Network-PagerDuty-Integration.html#t:RequesterId">RequesterId</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> Text</td><td class="doc"><p><code><a href="Network-PagerDuty-REST-Users.html#v:cuName">cuName</a></code></p></td></tr><tr><td class="src">-> <a href="Network-PagerDuty-Integration.html#t:Address">Address</a></td><td class="doc"><p><code><a href="Network-PagerDuty-REST-Users.html#v:cuEmail">cuEmail</a></code></p></td></tr><tr><td class="src">-> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a> s <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Create a new user for your account. An invite email will be sent asking
9 the user to choose a password.</p><pre>POST /users</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/users/create">http://developer.pagerduty.com/documentation/rest/users/create</a></p></div></div><div class="top"><p class="src"><a name="v:cuName" class="def">cuName</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a> s b) Text</p><div class="doc"><p>The name of the user.</p></div></div><div class="top"><p class="src"><a name="v:cuEmail" class="def">cuEmail</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a> s b) <a href="Network-PagerDuty-Integration.html#t:Address">Address</a></p><div class="doc"><p>The email of the user. The newly created user will receive an email asking
10 to confirm the subscription.</p></div></div><div class="top"><p class="src"><a name="v:cuRole" class="def">cuRole</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-PagerDuty-REST-Users.html#t:Role">Role</a>)</p><div class="doc"><p>The user's role.</p></div></div><div class="top"><p class="src"><a name="v:cuJobTitle" class="def">cuJobTitle</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Text)</p><div class="doc"><p>The job title of the user.</p></div></div><div class="top"><p class="src"><a name="v:cuTimeZone" class="def">cuTimeZone</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:CreateUser">CreateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> TimeZone)</p><div class="doc"><p>The time zone the user is in. If not specified, the time zone of the
11 account making the API call will be used.</p></div></div><h1 id="g:4">Get User</h1><div class="top"><p class="src"><a name="v:getUser" class="def">getUser</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></p><div class="doc"><p>Get information about an existing user.</p><pre>GET /users/:id</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/users/show">http://developer.pagerduty.com/documentation/rest/users/show</a></p></div></div><h1 id="g:5">Get User On Call</h1><div class="top"><p class="src"><a name="v:getUserOnCall" class="def">getUserOnCall</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></p><div class="doc"><p>Get a user object with that user's current on-call status. If the on-call
12 object is an empty list, the user is never on-call.</p><p>If the start and end of an on-call object are null, then the user is always
13 on-call for an escalation policy level.</p><pre>GET /users/:id/on_call</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/users/show_on_call">http://developer.pagerduty.com/documentation/rest/users/show_on_call</a></p></div></div><h1 id="g:6">Update User</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:UpdateUser" class="def">UpdateUser</a></p><div class="subs instances"><p id="control.i:UpdateUser" class="caption collapser" onclick="toggleSection('i:UpdateUser')">Instances</p><div id="section.i:UpdateUser" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a></td><td class="doc empty"> </td></tr><tr><td class="src">QueryLike <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:updateUser" class="def">updateUser</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a> s <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></p><div class="doc"><p>Update an existing user.</p><pre>PUT /users/:id</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/users/update">http://developer.pagerduty.com/documentation/rest/users/update</a></p></div></div><div class="top"><p class="src"><a name="v:uuName" class="def">uuName</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Text)</p><div class="doc"><p>The name of the user.</p></div></div><div class="top"><p class="src"><a name="v:uuEmail" class="def">uuEmail</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-PagerDuty-Integration.html#t:Address">Address</a>)</p><div class="doc"><p>The email of the user. The newly created user will receive an email asking
14 to confirm the subscription.</p></div></div><div class="top"><p class="src"><a name="v:uuRole" class="def">uuRole</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-PagerDuty-REST-Users.html#t:Role">Role</a>)</p><div class="doc"><p>The user's role.</p></div></div><div class="top"><p class="src"><a name="v:uuJobTitle" class="def">uuJobTitle</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Text)</p><div class="doc"><p>The job title of the user.</p></div></div><div class="top"><p class="src"><a name="v:uuTimeZone" class="def">uuTimeZone</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Users.html#t:UpdateUser">UpdateUser</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> TimeZone)</p><div class="doc"><p>The time zone the user is in. If not specified, the time zone of the
15 account making the API call will be used.</p></div></div><h1 id="g:7">Delete User</h1><div class="top"><p class="src"><a name="v:deleteUser" class="def">deleteUser</a> :: <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a> -> <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a></p><div class="doc"><p>Remove an existing user.</p><pre>DELETE /users/:id</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/users/delete">http://developer.pagerduty.com/documentation/rest/users/delete</a></p></div></div><h1 id="g:8">Types</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:PolicyInfo" class="def">PolicyInfo</a></p><div class="subs instances"><p id="control.i:PolicyInfo" class="caption collapser" onclick="toggleSection('i:PolicyInfo')">Instances</p><div id="section.i:PolicyInfo" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-REST-Users.html#t:PolicyInfo">PolicyInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-REST-Users.html#t:PolicyInfo">PolicyInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Users.html#t:PolicyInfo">PolicyInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-REST-Users.html#t:PolicyInfo">PolicyInfo</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:piId" class="def">piId</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:PolicyInfo">PolicyInfo</a> <a href="Network-PagerDuty-Integration.html#t:EscalationPolicyId">EscalationPolicyId</a></p></div><div class="top"><p class="src"><a name="v:piName" class="def">piName</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:PolicyInfo">PolicyInfo</a> Text</p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:OnCall" class="def">OnCall</a></p><div class="subs instances"><p id="control.i:OnCall" class="caption collapser" onclick="toggleSection('i:OnCall')">Instances</p><div id="section.i:OnCall" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-REST-Users.html#t:OnCall">OnCall</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-REST-Users.html#t:OnCall">OnCall</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Users.html#t:OnCall">OnCall</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-REST-Users.html#t:OnCall">OnCall</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:ocLevel" class="def">ocLevel</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:OnCall">OnCall</a> <a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Int.html#t:Int">Int</a></p></div><div class="top"><p class="src"><a name="v:ocStart" class="def">ocStart</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:OnCall">OnCall</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Date)</p></div><div class="top"><p class="src"><a name="v:ocEnd" class="def">ocEnd</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:OnCall">OnCall</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Date)</p></div><div class="top"><p class="src"><a name="v:ocEscalationPolicy" class="def">ocEscalationPolicy</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:OnCall">OnCall</a> <a href="Network-PagerDuty-REST-Users.html#t:PolicyInfo">PolicyInfo</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Role" class="def">Role</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:RoleAdmin" class="def">RoleAdmin</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:RoleUser" class="def">RoleUser</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:RoleLimitedUser" class="def">RoleLimitedUser</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Role" class="caption collapser" onclick="toggleSection('i:Role')">Instances</p><div id="section.i:Role" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-REST-Users.html#t:Role">Role</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-REST-Users.html#t:Role">Role</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Users.html#t:Role">Role</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-REST-Users.html#t:Role">Role</a></td><td class="doc empty"> </td></tr><tr><td class="src">Default <a href="Network-PagerDuty-REST-Users.html#t:Role">Role</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:HasUserInfo" class="def">HasUserInfo</a> a <span class="keyword">where</span></p><div class="subs minimal"><p class="caption">Minimal complete definition</p><p class="src"><a href="Network-PagerDuty-REST-Users.html#v:userInfo">userInfo</a></p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:userInfo" class="def">userInfo</a> :: Lens' a <a href="Network-PagerDuty-REST-Users.html#t:UserInfo">UserInfo</a></p><p class="src"><a name="v:uId" class="def">uId</a> :: Lens' a <a href="Network-PagerDuty-Integration.html#t:UserId">UserId</a></p><div class="doc"><p>The id of the user.</p></div><p class="src"><a name="v:uName" class="def">uName</a> :: Lens' a Text</p><div class="doc"><p>The name of the user.</p></div><p class="src"><a name="v:uEmail" class="def">uEmail</a> :: Lens' a <a href="Network-PagerDuty-Integration.html#t:Address">Address</a></p><div class="doc"><p>The user's email address.</p></div><p class="src"><a name="v:uColor" class="def">uColor</a> :: Lens' a Text</p><div class="doc"><p>The color used to represent the user in schedules.</p></div><p class="src"><a name="v:uTimeZone" class="def">uTimeZone</a> :: Lens' a TimeZone</p><div class="doc"><p>The user's personal time zone.</p></div></div><div class="subs instances"><p id="control.i:HasUserInfo" class="caption collapser" onclick="toggleSection('i:HasUserInfo')">Instances</p><div id="section.i:HasUserInfo" class="show"><table><tr><td class="src"><a href="Network-PagerDuty-REST-Users.html#t:HasUserInfo">HasUserInfo</a> <a href="Network-PagerDuty-REST-Users.html#t:UserInfo">UserInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Network-PagerDuty-REST-Users.html#t:HasUserInfo">HasUserInfo</a> <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Network-PagerDuty-REST-Users.html#t:HasUserInfo">HasUserInfo</a> <a href="Network-PagerDuty-REST-Schedules-Overrides.html#t:Override">Override</a></td><td class="doc empty"> </td></tr><tr><td class="src">(QueryLike a, ToJSON a, <a href="Network-PagerDuty-REST-Users.html#t:HasUserInfo">HasUserInfo</a> a) => <a href="Network-PagerDuty-REST-Users.html#t:HasUserInfo">HasUserInfo</a> (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> a s b)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:UserInfo" class="def">UserInfo</a></p><div class="subs instances"><p id="control.i:UserInfo" class="caption collapser" onclick="toggleSection('i:UserInfo')">Instances</p><div id="section.i:UserInfo" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-REST-Users.html#t:UserInfo">UserInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-REST-Users.html#t:UserInfo">UserInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Users.html#t:UserInfo">UserInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-REST-Users.html#t:UserInfo">UserInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Network-PagerDuty-REST-Users.html#t:HasUserInfo">HasUserInfo</a> <a href="Network-PagerDuty-REST-Users.html#t:UserInfo">UserInfo</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:User" class="def">User</a></p><div class="subs instances"><p id="control.i:User" class="caption collapser" onclick="toggleSection('i:User')">Instances</p><div id="section.i:User" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Network-PagerDuty-REST-Users.html#t:HasUserInfo">HasUserInfo</a> <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:uRole" class="def">uRole</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:User">User</a> <a href="Network-PagerDuty-REST-Users.html#t:Role">Role</a></p></div><div class="top"><p class="src"><a name="v:uAvatarUrl" class="def">uAvatarUrl</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:User">User</a> Text</p></div><div class="top"><p class="src"><a name="v:uUserUrl" class="def">uUserUrl</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:User">User</a> Text</p></div><div class="top"><p class="src"><a name="v:uInvitationSent" class="def">uInvitationSent</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:User">User</a> <a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Bool.html#t:Bool">Bool</a></p></div><div class="top"><p class="src"><a name="v:uJobTitle" class="def">uJobTitle</a> :: Lens' <a href="Network-PagerDuty-REST-Users.html#t:User">User</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Text)</p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.14.3</p></div></body></html>
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list