Base /organizations APIs

Use the base /organizations endpoints to manage your organization.


Retrieve Organization

GET /organizations/me

Retrieve your organization.

Retrieve Organization Response Fields

status
The status of the organization in terms of how it is associated with Cloud Elements.
environment
The Cloud Elements environment where the organization exists. This can be snapshot, staging, or production.
active
Indicates if the organization is active. In the JSON response true is active and false is inactive.
createdDate
The date when the organization administrator created the organization.
id
The unique identifier for an organization. Use in any /organizations endpoint with an {id} variable.
name
The name of the organization.
secret
The organization secret.
externalCompany
Cloud Elements internal data.
tierId
Cloud Elements internal data.
canCreatePeer

passwordPolicy
An object containing the password requirements for the organization.
customerId
The unique identifier of the organization.
twoFactorAuthEnabled
Indicates whether the organization enforces two-factor authentication.

Retrieve Organization Example Request

curl -X GET \
https://api.cloud-elements.com/elements/api-v2/organizations/me\ 
-H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \
-H 'Content-Type: application/json' \

Retrieve Organization Example Response

{  
  "active":true,
  "createdDate":"2017-01-18",
  "id":55579,
  "name":"Claude's  Company",
  "secret":"58168435e3b9959a929eb04b6218b9a2",
  "externalCompany":{  
    "revenue":0
  },
  "tierId":1,
  "canCreatePeer":false,
  "passwordPolicy":{  
    "minLength":1,
    "minUppercase":0,
    "minLowercase":0,
    "minNumbers":0,
    "minSymbols":0,
    "symbolCharacterSet":"!\"?$?%^&*()_-+={[}]:;@'~#|\\<,>?/.",
    "previousPasswordCount":0,
    "expirationDays":100000
  },
  "twoFactorAuthEnabled":false
}

Update Organization Name

PUT /organizations/me

Change the name of the organization.

 Request Body Parameters

name
The new name of the organization.

Update Organization Name Response Fields

status
The status of the organization in terms of how it is associated with Cloud Elements.
environment
The Cloud Elements environment where the organization exists. This can be snapshot, staging, or production.
active
Indicates if the organization is active. In the JSON response true is active and false is inactive.
createdDate
The date when the organization administrator created the organization.
id
The unique identifier for an organization. Use in any /organizations endpoint with an {id} variable.
name
The name of the organization.
secret
The organization secret.
externalCompany
Cloud Elements internal data.
tierId
Cloud Elements internal data.
canCreatePeer

passwordPolicy
An object containing the password requirements for the organization.
customerId
The unique identifier of the organization.
twoFactorAuthEnabled
Indicates whether the organization enforces two-factor authentication.

Update Organization Name Example Request

curl -X PUT \
https://api.cloud-elements.com/elements/api-v2/organizations/me \
  -H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "The Docs Company"
}'

Update Organization Name Example Response

{  
  "active":true,
  "createdDate":"2017-01-18",
  "id":55579,
  "name":"The Docs Company",
  "secret":"58168435e3b9959a929eb04b6218b9a2",
  "externalCompany":{  
    "revenue":0
  },
  "tierId":1,
  "canCreatePeer":false,
  "twoFactorAuthEnabled":false
}