AccountsResource
The following resources are part of this group:
/accounts
GET
Gets the accounts.
Parameters
name |
description |
type |
default |
limit |
the limit
|
query |
|
offset |
the offset
|
query |
|
businessUnit |
the business unit to filter by.
|
query |
|
route |
the route (id) to filter by.
|
query |
|
accountType |
the types of account to filter by. Could be more than one parameter with the same name.
|
query |
|
nameContains |
account name fragment to filter by. That parameter is used in conjunction with fields only.
|
query |
|
searchLoginName |
when true also search for login names matching this criteria
|
query |
|
fields |
the fields of account entity to return ("name" is supported at that version of the API). That parameter is used in conjunction with nameContains only.
|
query |
|
version |
(no documentation provided)
|
path |
|
Response Body
fully equipped account entities or partial ones based on fields query parameter
POST
Parameters
name |
description |
type |
default |
version |
(no documentation provided)
|
path |
|
Request Body
(no documentation provided)
/accounts/{name}
The following operations are supported on this resource:
DELETE
Delete and/or purge the account.
Parameters
name |
description |
type |
default |
name |
the name of the account that will be deleted.
|
path |
|
purge |
whether or not to purge the user's home folder
|
query |
|
version |
(no documentation provided)
|
path |
|
GET
Parameters
name |
description |
type |
default |
name |
(no documentation provided)
|
path |
|
version |
(no documentation provided)
|
path |
|
Response Body
(no documentation provided)
PUT
Parameters
name |
description |
type |
default |
name |
(no documentation provided)
|
path |
|
version |
(no documentation provided)
|
path |
|
Request Body
(no documentation provided)
POST
Parameters
name |
description |
type |
default |
name |
(no documentation provided)
|
path |
|
version |
(no documentation provided)
|
path |
|
Request Body
(no documentation provided)
/accounts/{accountName}/users
GET
Gets the users for a given account.
Parameters
name |
description |
type |
default |
accountName |
the account name
|
path |
|
version |
(no documentation provided)
|
path |
|
Response Body
the users
POST
Creates the users for an account. In this version of the API only one user per account is allowed.
Current password policies will be applied if the password has been specified.
If passwordDigest is specified password policies will not be applied.
Parameters
name |
description |
type |
default |
accountName |
the account name
|
path |
|
version |
(no documentation provided)
|
path |
|
Request Body
the users
/accounts/{name}/convertToLicensed
POST
Parameters
name |
description |
type |
default |
name |
(no documentation provided)
|
path |
|
version |
(no documentation provided)
|
path |
|
/accounts/{accountName}/users/{userName}
The following operations are supported on this resource:
GET
Gets an user with the given name.
Parameters
name |
description |
type |
default |
accountName |
the account name
|
path |
|
userName |
the user name
|
path |
|
version |
(no documentation provided)
|
path |
|
Response Body
the users
POST
Creates an user for an account. Replaces the user if there is an user with the same name.
In this version of the API only one user per account is allowed.
Current password policies will be applied if the password has been specified.
If passwordDigest is specified password policies will not be applied.
Parameters
name |
description |
type |
default |
accountName |
the account name
|
path |
|
userName |
the user name
|
path |
|
version |
(no documentation provided)
|
path |
|
Request Body
the user
PUT
Creates an user for an account. Replaces the user if there is an user with the same name.
In this version of the API only one user per account is allowed.
Current password policies will be applied if the password has been specified.
If passwordDigest is specified password policies will not be applied.
Parameters
name |
description |
type |
default |
accountName |
the account name
|
path |
|
userName |
the user name
|
path |
|
version |
(no documentation provided)
|
path |
|
Request Body
the user
DELETE
Parameters
name |
description |
type |
default |
accountName |
(no documentation provided)
|
path |
|
userName |
(no documentation provided)
|
path |
|
version |
(no documentation provided)
|
path |
|
/accounts/{name}/addressBook/contacts
GET
Parameters
name |
description |
type |
default |
name |
(no documentation provided)
|
path |
|
fullName |
(no documentation provided)
|
query |
|
primaryEmail |
(no documentation provided)
|
query |
|
limit |
(no documentation provided)
|
query |
|
offset |
(no documentation provided)
|
query |
|
version |
(no documentation provided)
|
path |
|
Response Body
(no documentation provided)
POST
Parameters
name |
description |
type |
default |
name |
(no documentation provided)
|
path |
|
version |
(no documentation provided)
|
path |
|
Request Body
(no documentation provided)
Response Body
(no documentation provided)
/accounts/{name}/addressBook/contacts/{id}
DELETE
Parameters
name |
description |
type |
default |
name |
(no documentation provided)
|
path |
|
id |
(no documentation provided)
|
path |
|
version |
(no documentation provided)
|
path |
|
Response Body
(no documentation provided)
PUT
Parameters
name |
description |
type |
default |
name |
(no documentation provided)
|
path |
|
id |
(no documentation provided)
|
path |
|
version |
(no documentation provided)
|
path |
|
Request Body
(no documentation provided)
Response Body
(no documentation provided)