Create a user

Create a new user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the API Concepts Document

Scoped OAuth requires: users.write

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"

Content-Type*"application/json"

Default"application/json"

Value in

"application/json"

From*string

The email address of a valid user associated with the account making the request.

Formatemail

Request Body

application/json

The user to be created.

TypeScript Definitions

Use the request body type in TypeScript.

user*

Response Body

`application/json`

curl -X POST "https://example.com/users" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json" \  -H "From: user@example.com" \  -H "Content-Type: application/json" \  -d '{    "user": {      "type": "user",      "name": "Earline Greenholt",      "email": "125.greenholt.earline@graham.name",      "time_zone": "America/Lima",      "color": "green",      "role": "admin",      "job_title": "Director of Engineering",      "avatar_url": "https://secure.gravatar.com/avatar/1d1a39d4635208d5664082a6c654a73f.png?d=mm&r=PG",      "description": "I\'m the boss",      "license": {        "id": "PTDVERC",        "type": "license_reference"      }    }  }'

{  "user": {    "id": "PXPGF42",    "type": "user",    "summary": "Earline Greenholt",    "self": "https://api.pagerduty.com/users/PXPGF42",    "html_url": "https://subdomain.pagerduty.com/users/PXPGF42",    "name": "Earline Greenholt",    "email": "125.greenholt.earline@graham.name",    "time_zone": "America/Lima",    "color": "green",    "role": "admin",    "avatar_url": "https://secure.gravatar.com/avatar/a8b714a39626f2444ee05990b078995f.png?d=mm&r=PG",    "description": "I'm the boss",    "invitation_sent": false,    "created_via_sso": true,    "contact_methods": [      {        "id": "PTDVERC",        "type": "email_contact_method_reference",        "summary": "Default",        "self": "https://api.pagerduty.com/users/PXPGF42/contact_methods/PTDVERC"      }    ],    "notification_rules": [      {        "id": "P8GRWKK",        "type": "assignment_notification_rule_reference",        "summary": "Default",        "self": "https://api.pagerduty.com/users/PXPGF42/notification_rules/P8GRWKK",        "html_url": null      }    ],    "job_title": "Director of Engineering",    "teams": [      {        "id": "PQ9K7I8",        "type": "team_reference",        "summary": "Engineering",        "self": "https://api.pagerduty.com/teams/PQ9K7I8",        "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"      }    ]  }}

Create a user

Authorization

Header Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

402application/json

403application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`