Home
Version 3
Users API

Users API

Creating a User

POST /v2/users/

Request

Route

POST /v2/users

Body

Name Description Default Valid Values Example Values
guid The UAA guid of the user to create.
  • guid-cb179e14-53ee-46e1-b3dc-e07ed7406625
default_space_guid The guid of the default space for apps created by this user.
admin Whether the user is an admin (Use UAA instead).
{
  "guid": "guid-cb179e14-53ee-46e1-b3dc-e07ed7406625"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1MyIsImVtYWlsIjoiZW1haWwtMjcyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5OTl9.J2SDyjHwIzz62ho3jZJJMFopHuLXkBMdfw1MVWTf25E
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/users" -d '{
  "guid": "guid-cb179e14-53ee-46e1-b3dc-e07ed7406625"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1MyIsImVtYWlsIjoiZW1haWwtMjcyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5OTl9.J2SDyjHwIzz62ho3jZJJMFopHuLXkBMdfw1MVWTf25E" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "guid-cb179e14-53ee-46e1-b3dc-e07ed7406625",
    "url": "/v2/users/guid-cb179e14-53ee-46e1-b3dc-e07ed7406625",
    "created_at": "2015-05-21T01:03:19Z",
    "updated_at": null
  },
  "entity": {
    "admin": false,
    "active": false,
    "default_space_guid": null,
    "spaces_url": "/v2/users/guid-cb179e14-53ee-46e1-b3dc-e07ed7406625/spaces",
    "organizations_url": "/v2/users/guid-cb179e14-53ee-46e1-b3dc-e07ed7406625/organizations",
    "managed_organizations_url": "/v2/users/guid-cb179e14-53ee-46e1-b3dc-e07ed7406625/managed_organizations",
    "billing_managed_organizations_url": "/v2/users/guid-cb179e14-53ee-46e1-b3dc-e07ed7406625/billing_managed_organizations",
    "audited_organizations_url": "/v2/users/guid-cb179e14-53ee-46e1-b3dc-e07ed7406625/audited_organizations",
    "managed_spaces_url": "/v2/users/guid-cb179e14-53ee-46e1-b3dc-e07ed7406625/managed_spaces",
    "audited_spaces_url": "/v2/users/guid-cb179e14-53ee-46e1-b3dc-e07ed7406625/audited_spaces"
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/users/guid-cb179e14-53ee-46e1-b3dc-e07ed7406625
X-VCAP-Request-ID: 7ff5b9d4-9506-4113-a309-7282c7ee2e6c
Content-Length: 1014
X-Content-Type-Options: nosniff