Actions supported by the Organizations API

Action: create

This action returns the ID and the name of the created organization.

Example

https://powerfolder.example.com/api/organizations?action=create&name=Power

{
	"ID":"TVD8LaCbpvx3NJH8SCDx",
	"Name":"Blab"
}

Action: getInfo

This action returns several informations about a organization.

Example

https://powerfolder.example.com/api/organizations?action=getInfo&OID=DveE4UFBVRgmvmHrGC1w

{
	"id":"DveE4UFBVRgmvmHrGC1w",
	"maxUsers":15,
	"nUsers": 13,
	"name":"I am the name of an organization",
	"storageSize":53687091200,
	"storageUsed":26843545600,
	"notes":"I am a note",
	"domains":["example.com", "example.org"],
	"jsonData":{"isBusiness":"true"}
}

Action: getOrganizations

This action returns a list of organizations available on the server.

TruJsi69ag6ar2fVC1SF

Example

https://powerfolder.example.com/api/organizations?action=getOrganizations&query=Power

{
  "ResultSet":{
    "Result":[
      {
        "ID":"Aey7sUi7N4R9r5CZ6vxS",
        "name":"PowerFolder",
		"maxUsers: 10,
		"nUsers": 8,
        "notes":"Created in 2007"
      },
      {
        "ID":"Wni7DFkmdySELqBdsUs8",
        "name":"Power for Tomorrow",
		"maxUsers: 5,
		"nUsers": 2,
        "notes":"Sustainable Energy Solutions"
      }
    ]
  }
}

Action: rename

This action renames an organization.

Example

http://powerfolder.example.com/api/organizations?action=rename&OID=Wni7DFkmdySELqBdsUs8&name=Power%20of%20Tomorrow

Action: changeNotes

This action changes the notes of an organization.

Example

http://powerfolder.example.com/api/organizations?action=changeNotes&OID=Wni7DFkmdySELqBdsUs8¬es=Sustainable%20Energy

Action: changeSize

This action changes the storage size that can be distributed among the users.

Example

http://powerfolder.example.com/api/organizations?action=changeSize&OID=Wni7DFkmdySELqBdsUs8&storageSizeGB=123

Action: changeValidFrom

This action changes the validity starting date of this organization.

Example

http://powerfolder.example.com/api/organizations?action=changeValidFrom&OID=Wni7DFkmdySELqBdsUs8&OSValidTill=10%20DEC%202010

Action: changeValidTill

This action changes the validity ending date of this organization.

Example

http://powerfolder.example.com/api/organizations?action=changeValidTill&OID=Wni7DFkmdySELqBdsUs8&OSValidTill=10%20DEC%202010

Action: changeMaxUsers

This action changes the number of maximum users allowed on the organization.

Example

http://powerfolder.example.com/api/organizations?action=changeMaxUsers&OID=Wni7DFkmdySELqBdsUs8&maxUsers=103

Action: addAdmin

This action allows an administrator or a user with OrganizationCreatePermission and the specific OrganizationAdminPermission of that Organization to add Administrators to the Organization.

Example

http://powerfolder.example.com/api/organizations?action=addAdmin&OID=Wni7DFkmdySELqBdsUs8&accountID=PME2myo2355sRegfgKk8m0YdA

{
  "message":"Granted permission OrganizationAdminPermission for account: john@example.org"
}

Action: removeAdmin

This action allows an administrator or a user with OrganizationCreatePermission and the specific OrganizationAdminPermission of that Organization to remove Administrators from the Organization.

Example

http://powerfolder.example.com/api/organizations?action=removeAdmin&OID=Wni7DFkmdySELqBdsUs8&accountID=PME2myo2355sRegfgKk8m0YdA

{
  "message":"Revoked permission OrganizationAdminPermission for account: john@example.org"
}

Action: addDomain

This action allows a user with OrganizationCreatePermission to add domains to an organization.

Example

http://powerfolder.example.com/api/organizations?action=addDomain&OID=Wni7DFkmdySELqBdsUs8&domain=example.org&domain=sub.example.org

Action: removeDomain

This action allows a user with OrganizationCreatePermission to remove domains from an organization.

Example

http://powerfolder.example.com/api/organizations?action=removeDomain&OID=Wni7DFkmdySELqBdsUs8&domain=example.org&domain=sub.example.org

Action: setJSON

Using this action you can store custom data as key value pairs to a JSON field of the organization. To do so any HTTP parameter added to the call to this API endpoint except action and OID will be added to the custom data.

Example

http://powerfolder.example.com/api/organizations?action=setJSON&OID=Wni7DFkmdySELqBdsUs8&isBusiness=true&foo=bar

{
	"information":{"isBusiness":"true", "foo":"bar"},
	"OID":"Wni7DFkmdySELqBdsUs8",
	"message":"Added information to Organization"
}

Action: removeJSON

Using this action you can remove custom data from the JSON field of the organization. To do so any HTTP parameter's key (name) added to the call to this API endpoint except action and OID will be removed from the custom data.

Example

http://powerfolder.example.com/api/organizations?action=removeJSON&OID=Wni7DFkmdySELqBdsUs8&isBusiness=

{
	"information":{"foo":"bar"},
	"OID":"Wni7DFkmdySELqBdsUs8",
	"message":"Removed information from Organization"
}

Action: restrictToDomain

This call allows you to restrict the members of an Organization to the defined set of domains.

Example

http://powerfolder.example.com/api/organizations?action=restrictToDomain&OID=Wni7DFkmdySELqBdsUs8&set=true

{
	"message":"Set restrict to domain to true"
}