Home
Version 3
Organizations API

Organizations API

Associate User with the Organization by Username

PUT v2/organizations/:guid/users

Request

Route

PUT v2/organizations/b3e201d1-f6e8-4dfa-a304-a3c4921caecb/users

Parameters

Name Description Valid Values Example Values
guid The guid of the Organization

Body

Name Description Default Valid Values Example Values
username The user's name
  • user@example.com
{
  "username": "user@example.com"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMyIsImVtYWlsIjoiZW1haWwtNzlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1ODg1NTY2OH0.VhPurGIr-_f0vCEf11xYLY-5ukz9hsZYxHyiXYXC0oQ
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]v2/organizations/b3e201d1-f6e8-4dfa-a304-a3c4921caecb/users" -d '{
  "username": "user@example.com"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMyIsImVtYWlsIjoiZW1haWwtNzlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1ODg1NTY2OH0.VhPurGIr-_f0vCEf11xYLY-5ukz9hsZYxHyiXYXC0oQ" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "b3e201d1-f6e8-4dfa-a304-a3c4921caecb",
    "url": "/v2/organizations/b3e201d1-f6e8-4dfa-a304-a3c4921caecb",
    "created_at": "2016-03-17T21:41:08Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-370",
    "billing_enabled": false,
    "quota_definition_guid": "bb15de1d-cc0d-4f30-a41b-7dfe1ecdce2c",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/bb15de1d-cc0d-4f30-a41b-7dfe1ecdce2c",
    "spaces_url": "/v2/organizations/b3e201d1-f6e8-4dfa-a304-a3c4921caecb/spaces",
    "domains_url": "/v2/organizations/b3e201d1-f6e8-4dfa-a304-a3c4921caecb/domains",
    "private_domains_url": "/v2/organizations/b3e201d1-f6e8-4dfa-a304-a3c4921caecb/private_domains",
    "users_url": "/v2/organizations/b3e201d1-f6e8-4dfa-a304-a3c4921caecb/users",
    "managers_url": "/v2/organizations/b3e201d1-f6e8-4dfa-a304-a3c4921caecb/managers",
    "billing_managers_url": "/v2/organizations/b3e201d1-f6e8-4dfa-a304-a3c4921caecb/billing_managers",
    "auditors_url": "/v2/organizations/b3e201d1-f6e8-4dfa-a304-a3c4921caecb/auditors",
    "app_events_url": "/v2/organizations/b3e201d1-f6e8-4dfa-a304-a3c4921caecb/app_events",
    "space_quota_definitions_url": "/v2/organizations/b3e201d1-f6e8-4dfa-a304-a3c4921caecb/space_quota_definitions"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 1299
X-Content-Type-Options: nosniff