/users

/users post

post

Create a new user

Secured by oauth_2_0

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

Request
Security

Body

Media type: application/json

Type: object

Properties

username: required (string - minLength: 2 - maxLength: 30 - pattern: ^[a-z0-9]{2,30}$)
firstname: required (string)
lastname: required (string)
publicKeys: required (array of )
expire: (datetime)
digitalwallet: required (array of DigitalAssetAddress)
Items: DigitalAssetAddress
- address: required (string)
- label: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
- expire: required (datetime)
- currencysymbol: required (string)
- noexpiration: (boolean)
  Flag that represents whether or not this digital asset expires. If true, the expire field can be ignored.
emailaddresses: required (array of EmailAddress)
Items: EmailAddress
- label: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
- emailaddress: required (string)
phonenumbers: required (array of Phonenumber)
Items: Phonenumber
- phonenumber: required (string - pattern: \+[0-9]{6,50}$)
- label: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
addresses: required (array of Address)
Items: Address
- city: required (string - maxLength: 30)
- street: required (string - maxLength: 50)
- nr: required (string - maxLength: 10)
- other: (string - maxLength: 30)
- country: required (string - maxLength: 40)
- postalcode: required (string - maxLength: 20)
- label: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
bankaccounts: required (array of BankAccount)
Items: BankAccount
- iban: required (string - maxLength: 30)
- bic: required (string - maxLength: 11)
- country: required (string - maxLength: 40)
- label: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
facebook: (object)
- id: required (integer)
- name: required (string)
- picture: required (string)
- link: required (string)
github: (object)
- login: required (string)
- id: required (integer)
- avatar_url: required (string)
- html_url: required (string)
- name: required (string)

Example:

{
  "username": "bob",
  "firstname": "Bob",
  "lastname": "Johnson",
  "publicKeys": [
    "1GVS7544tvWM2TM13vNH8sboamJzL6mJ36"
  ],
  "expire": "2018-10-20T16:41:41.090Z",
  "emailaddresses": [
    {
      "label": "work",
      "emailaddress": "bob@company.com"
    },
    {
      "label": "home",
      "emailaddress": "bob@example.com"
    }
  ],
  "digitalwallet": [
    {
      "label": "bibcoin",
      "address": "fdfgfgergerger",
      "expire": "2018-10-20T16:41:41.090Z",
      "currencysymbol": "bb"
    }
  ],
  "phonenumbers": [
    {
      "label": "be",
      "phonenumber": "+3212341234123"
    },
    {
      "label": "eg",
      "phonenumber": "+2012341234123"
    }
  ],
  "addresses": [
    {
      "label": "home",
      "city": "Springfield",
      "street": "Main street",
      "nr": "45B",
      "country": "Tomorrowland",
      "postalcode": "T-9450"
    },
    {
      "label": "work",
      "city": "Capital City",
      "street": "Capital street",
      "nr": "1",
      "country": "Tomorrowland",
      "postalcode": "T-1000"
    }
  ],
  "bankaccounts": [
    {
      "label": "kbc",
      "iban": "TL123451234512345",
      "bic": "ABCDEFGH",
      "country": "Tomorrowland"
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/users/{username} get

get

Secured by oauth_2_0 with scopes:

user:admin

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

username: required (string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

username: required (string - minLength: 2 - maxLength: 30 - pattern: ^[a-z0-9]{2,30}$)
firstname: required (string)
lastname: required (string)
publicKeys: required (array of )
expire: (datetime)
digitalwallet: required (array of DigitalAssetAddress)
Items: DigitalAssetAddress
- address: required (string)
- label: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
- expire: required (datetime)
- currencysymbol: required (string)
- noexpiration: (boolean)
  Flag that represents whether or not this digital asset expires. If true, the expire field can be ignored.
emailaddresses: required (array of EmailAddress)
Items: EmailAddress
- label: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
- emailaddress: required (string)
phonenumbers: required (array of Phonenumber)
Items: Phonenumber
- phonenumber: required (string - pattern: \+[0-9]{6,50}$)
- label: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
addresses: required (array of Address)
Items: Address
- city: required (string - maxLength: 30)
- street: required (string - maxLength: 50)
- nr: required (string - maxLength: 10)
- other: (string - maxLength: 30)
- country: required (string - maxLength: 40)
- postalcode: required (string - maxLength: 20)
- label: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
bankaccounts: required (array of BankAccount)
Items: BankAccount
- iban: required (string - maxLength: 30)
- bic: required (string - maxLength: 11)
- country: required (string - maxLength: 40)
- label: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
facebook: (object)
- id: required (integer)
- name: required (string)
- picture: required (string)
- link: required (string)
github: (object)
- login: required (string)
- id: required (integer)
- avatar_url: required (string)
- html_url: required (string)
- name: required (string)

Example:

{
  "username": "bob",
  "firstname": "Bob",
  "lastname": "Johnson",
  "publicKeys": [
    "1GVS7544tvWM2TM13vNH8sboamJzL6mJ36"
  ],
  "expire": "2018-10-20T16:41:41.090Z",
  "emailaddresses": [
    {
      "label": "work",
      "emailaddress": "bob@company.com"
    },
    {
      "label": "home",
      "emailaddress": "bob@example.com"
    }
  ],
  "digitalwallet": [
    {
      "label": "bibcoin",
      "address": "fdfgfgergerger",
      "expire": "2018-10-20T16:41:41.090Z",
      "currencysymbol": "bb"
    }
  ],
  "phonenumbers": [
    {
      "label": "be",
      "phonenumber": "+3212341234123"
    },
    {
      "label": "eg",
      "phonenumber": "+2012341234123"
    }
  ],
  "addresses": [
    {
      "label": "home",
      "city": "Springfield",
      "street": "Main street",
      "nr": "45B",
      "country": "Tomorrowland",
      "postalcode": "T-9450"
    },
    {
      "label": "work",
      "city": "Capital City",
      "street": "Capital street",
      "nr": "1",
      "country": "Tomorrowland",
      "postalcode": "T-1000"
    }
  ],
  "bankaccounts": [
    {
      "label": "kbc",
      "iban": "TL123451234512345",
      "bic": "ABCDEFGH",
      "country": "Tomorrowland"
    }
  ]
}

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/users/{username}/apikeys/{label} put get delete

put

Updates the label for the API key

get

Get an API key by label

delete

Removes an API key

/users/{username}/totp get post delete

get

Get a TOTP secret and issuer that can be used for setting up two-factor authentication.

post

Enable two-factor authentication using TOTP.

delete

Disable TOTP two-factor authentication.

/users/{username}/addresses get post

get

List of all of the user his addresses.

post

/users/{username}/addresses/{label} get put delete

get

Get the details of an address.

put

Update the label and/or value of an existing address.

delete

Removes an address

/users/{username}/digitalwallet get post

get

List all of the user his digital wallets.

post

/users/{username}/digitalwallet/{label} get put delete

get

Get the details of a digital wallet address.

put

Update the label and/or value of an existing address.

delete

Removes an address

/users/{username}/phonenumbers/{label} get put delete

get

Get the details of a phone number.

put

Update the label and/or value of an existing phonenumber.

delete

Removes a phonenumber

/users/{username}/banks/{label} get put delete

get

Get the details of a bank account

put

Update an existing bankaccount and label.

delete

Delete a BankAccount

/users/{username}/notifications get

get

Get the list of notifications, these are pending invitations or approvals or other requests.

Secured by oauth_2_0 with scopes:

user:admin

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

username: required (string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

invitations: required (array of JoinOrganizationInvitation)
Items: JoinOrganizationInvitation
- organization: required (string)
- user: required (string)
- role: required (one of owner, member, orgowner, orgmember)
- created: (datetime)
- status: required (one of pending, accepted, rejected)
- method: required (one of website, email, phone)
- emailaddress: required (string)
- phonenumber: required (string)
- isorganization: required (boolean)
Example:
```
{
  "organization": "mycoolsoccerclub",
  "user": "bob",
  "role": "owner",
  "created": "2016-02-28T16:41:41.090Z",
  "status": "pending",
  "method": "website",
  "emailaddress": "",
  "phonenumber": "",
  "isorganization": false
}
```
approvals: required (array of JoinOrganizationInvitation)
Items: JoinOrganizationInvitation
- organization: required (string)
- user: required (string)
- role: required (one of owner, member, orgowner, orgmember)
- created: (datetime)
- status: required (one of pending, accepted, rejected)
- method: required (one of website, email, phone)
- emailaddress: required (string)
- phonenumber: required (string)
- isorganization: required (boolean)
Example:
```
{
  "organization": "mycoolsoccerclub",
  "user": "bob",
  "role": "owner",
  "created": "2016-02-28T16:41:41.090Z",
  "status": "pending",
  "method": "website",
  "emailaddress": "",
  "phonenumber": "",
  "isorganization": false
}
```
contractRequests: required (array of ContractSigningRequest)
Items: ContractSigningRequest
- contractId: required (string)
- party: required (string)
missingscopes: required (array of MissingScopes)
Items: MissingScopes
- organization: required (string)
- scopes: required (array of )

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/users/{username}/contracts get post

get

Get the contracts where the user is 1 of the parties. Order descending by date.

post

Create a new contract.

Secured by oauth_2_0 with scopes:

user:admin

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

username: required (string)

Body

Media type: application/json

Type: object

Properties

parties: required (array of Party)
Items: Party
- type: required (string)
- name: required (string)
content: required (string)
contractType: required (string - maxLength: 40)
Free field to be used for tags by the party creating a contract
invalidates: (array of )
list of contractId's this contract invalidates.
extends: (array of )
list of contractId's this contract is an extension upon
expires: required (datetime)
contractId: required (string)
The contractId is the hash of the parties, the content, the contractType, and the expiration date. To calculate the hash, take the json representation of the contract without the id and signatures, trim the newlines or spaces (except when they appear in the values) and encode in utf8. From this result, take a SHA256 followed by a RIPEMD160, next base58CheckEncode the result with a 0x00 prefix.
signatures: required (array of Signature)
Items: Signature
- signedBy: required (string)
- date: required (datetime)
- publicKey: required (string)
  The public key used
- signature: required (string)

HTTP status code 201

Body

Media type: application/json

Type: object

Properties

parties: required (array of Party)
Items: Party
- type: required (string)
- name: required (string)
content: required (string)
contractType: required (string - maxLength: 40)
Free field to be used for tags by the party creating a contract
invalidates: (array of )
list of contractId's this contract invalidates.
extends: (array of )
list of contractId's this contract is an extension upon
expires: required (datetime)
contractId: required (string)
The contractId is the hash of the parties, the content, the contractType, and the expiration date. To calculate the hash, take the json representation of the contract without the id and signatures, trim the newlines or spaces (except when they appear in the values) and encode in utf8. From this result, take a SHA256 followed by a RIPEMD160, next base58CheckEncode the result with a 0x00 prefix.
signatures: required (array of Signature)
Items: Signature
- signedBy: required (string)
- date: required (datetime)
- publicKey: required (string)
  The public key used
- signature: required (string)

HTTP status code 401

Unauthorized

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/users/{username}/authorizations get

get

Get the list of authorizations.

Secured by oauth_2_0 with scopes:

user:admin

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

username: required (string)

HTTP status code 200

Body

Media type: application/json

Type: array of Authorization

Items: Authorization

username: required (string)
grantedTo: required (string)
The organization that is granted read access to some of the user's information
addresses: (array of AuthorizationMap)
Mapping of the labels of the granted ones to the labels the organization requested.
Items: AuthorizationMap
- requestedlabel: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
- reallabel: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
publicKeys: (array of AuthorizationMap)
Items: AuthorizationMap
- requestedlabel: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
- reallabel: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
emailaddresses: (array of AuthorizationMap)
Mapping of the labels of the granted ones to the labels the organization requested.
Items: AuthorizationMap
- requestedlabel: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
- reallabel: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
phonenumbers: (array of AuthorizationMap)
Mapping of the labels of the granted ones to the labels the organization requested.
Items: AuthorizationMap
- requestedlabel: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
- reallabel: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
bankaccounts: (array of AuthorizationMap)
Mapping of the labels of the granted ones to the labels the organization requested.
Items: AuthorizationMap
- requestedlabel: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
- reallabel: required (string - minLength: 2 - maxLength: 50 - pattern: ^[a-zA-Z\d\-_\s]{2,50}$)
facebook: (boolean)
github: (boolean)
organizations: required (array of )
List of organizations the requesting organization can see your membership of.

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/users/{username}/organizations/{globalid}/roles/{role} post delete

post

Accept membership in organization

delete

Reject membership invitation in an organization.

Accept membership in organization

Secured by oauth_2_0

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

username: required (string)
globalid: required (string)
role: required (string)

Body

Media type: application/json

Type: object

Properties

organization: required (string)
user: required (string)
role: required (one of owner, member, orgowner, orgmember)
created: (datetime)
status: required (one of pending, accepted, rejected)
method: required (one of website, email, phone)
emailaddress: required (string)
phonenumber: required (string)
isorganization: required (boolean)

Example:

{
  "organization": "mycoolsoccerclub",
  "user": "bob",
  "role": "owner",
  "created": "2016-02-28T16:41:41.090Z",
  "status": "pending",
  "method": "website",
  "emailaddress": "",
  "phonenumber": "",
  "isorganization": false
}

HTTP status code 201

Body

Media type: application/json

Type: object

Properties

organization: required (string)
user: required (string)
role: required (one of owner, member, orgowner, orgmember)
created: (datetime)
status: required (one of pending, accepted, rejected)
method: required (one of website, email, phone)
emailaddress: required (string)
phonenumber: required (string)
isorganization: required (boolean)

Example:

{
  "organization": "mycoolsoccerclub",
  "user": "bob",
  "role": "owner",
  "created": "2016-02-28T16:41:41.090Z",
  "status": "pending",
  "method": "website",
  "emailaddress": "",
  "phonenumber": "",
  "isorganization": false
}

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/users/{username}/publickeys/{label} get put delete

get

Get a public key

put

Upates the label and/or key of an existing public key

delete

Delete a public key

/users/{username}/keystore get post

get

Lists all keys written to this users keystore by the accessing organization

post

Saves a new key to this users keystore. The username, globalid and timestamp will be overwritten

/users/{username}/see get post

get

Get a list of all see objects.

post

Create new see object

/users/{username}/see/{uniqueid}/{globalid} get put

get

Get a see object

put

Updates a see object

/organizations

/organizations post

post

Create a new organization. 1 user should be in the owners list. Validation is performed to check if the securityScheme allows management on this user.

Secured by oauth_2_0

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

Body

Media type: application/json

Type: object

Properties

globalid: required (string - minLength: 3 - maxLength: 150 - pattern: ^[a-z\d\-_\s]{3,150}$)
publicKeys: required (array of )
dns: required (array of )
List of organization DNS.
owners: required (array of )
List of users usernames.
members: required (array of )
List of users who are member in this organization.
orgowners: required (array of )
List of other organizations who act as an owner in this organization.
orgmembers: required (array of )
List of other organizations who act as a member in this organization.
includes: required (array of )
globalId of sub organizations
requiredscopes: required (array of RequiredScope)
List of scopes that are required to join this organization
Items: RequiredScope
- scope: required (string - maxLength: 1024)
  Scope which should be shared with an organization
- accessscopes: required (array of )
  Which users can see the shared information.
includesuborgsof: required (array of )
List of orgowners and orgmembers who's children should be included in the organizations membershi or ownership hierarchy

Example:

{
  "globalid": "greenitglobe",
  "publicKeys": [
    "1A9WWh6iAE4RZGN7axy6xZbuWuLknqWLrV"
  ],
  "dns": [
    "greenitglobe.com"
  ],
  "owners": [
    "user1",
    "user2",
    "user3"
  ],
  "members": [
    "user4"
  ],
  "orgowners": [
    "organization1"
  ],
  "orgmembers": [
    "organization2",
    "organization3"
  ],
  "includes": [
    "admin.greenitglobe.com"
  ],
  "requiredscopes": [
    {
      "scope": "user:name",
      "accessscopes": [
        "organization:owner",
        "organization:member"
      ]
    },
    {
      "scope": "user:email:personal email",
      "accessscopes": [
        "organization:owner"
      ]
    }
  ],
  "includesuborgsof": [
    "organization2"
  ]
}

HTTP status code 201

Body

Media type: application/json

Type: object

Properties

globalid: required (string - minLength: 3 - maxLength: 150 - pattern: ^[a-z\d\-_\s]{3,150}$)
publicKeys: required (array of )
dns: required (array of )
List of organization DNS.
owners: required (array of )
List of users usernames.
members: required (array of )
List of users who are member in this organization.
orgowners: required (array of )
List of other organizations who act as an owner in this organization.
orgmembers: required (array of )
List of other organizations who act as a member in this organization.
includes: required (array of )
globalId of sub organizations
requiredscopes: required (array of RequiredScope)
List of scopes that are required to join this organization
Items: RequiredScope
- scope: required (string - maxLength: 1024)
  Scope which should be shared with an organization
- accessscopes: required (array of )
  Which users can see the shared information.
includesuborgsof: required (array of )
List of orgowners and orgmembers who's children should be included in the organizations membershi or ownership hierarchy

Example:

{
  "globalid": "greenitglobe",
  "publicKeys": [
    "1A9WWh6iAE4RZGN7axy6xZbuWuLknqWLrV"
  ],
  "dns": [
    "greenitglobe.com"
  ],
  "owners": [
    "user1",
    "user2",
    "user3"
  ],
  "members": [
    "user4"
  ],
  "orgowners": [
    "organization1"
  ],
  "orgmembers": [
    "organization2",
    "organization3"
  ],
  "includes": [
    "admin.greenitglobe.com"
  ],
  "requiredscopes": [
    {
      "scope": "user:name",
      "accessscopes": [
        "organization:owner",
        "organization:member"
      ]
    },
    {
      "scope": "user:email:personal email",
      "accessscopes": [
        "organization:owner"
      ]
    }
  ],
  "includesuborgsof": [
    "organization2"
  ]
}

HTTP status code 401

Unauthorized

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/organizations/{globalid} get post delete

get

Get organization info

post

Create a new suborganization.

delete

Deletes an organization and all data linked to it (join-organization-invitations, oauth_access_tokens, oauth_clients, logo)

Get organization info

Secured by oauth_2_0 with scopes:

organization:member
organization:owner

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

globalid: required (string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

globalid: required (string - minLength: 3 - maxLength: 150 - pattern: ^[a-z\d\-_\s]{3,150}$)
publicKeys: required (array of )
dns: required (array of )
List of organization DNS.
owners: required (array of )
List of users usernames.
members: required (array of )
List of users who are member in this organization.
orgowners: required (array of )
List of other organizations who act as an owner in this organization.
orgmembers: required (array of )
List of other organizations who act as a member in this organization.
includes: required (array of )
globalId of sub organizations
requiredscopes: required (array of RequiredScope)
List of scopes that are required to join this organization
Items: RequiredScope
- scope: required (string - maxLength: 1024)
  Scope which should be shared with an organization
- accessscopes: required (array of )
  Which users can see the shared information.
includesuborgsof: required (array of )
List of orgowners and orgmembers who's children should be included in the organizations membershi or ownership hierarchy

Example:

{
  "globalid": "greenitglobe",
  "publicKeys": [
    "1A9WWh6iAE4RZGN7axy6xZbuWuLknqWLrV"
  ],
  "dns": [
    "greenitglobe.com"
  ],
  "owners": [
    "user1",
    "user2",
    "user3"
  ],
  "members": [
    "user4"
  ],
  "orgowners": [
    "organization1"
  ],
  "orgmembers": [
    "organization2",
    "organization3"
  ],
  "includes": [
    "admin.greenitglobe.com"
  ],
  "requiredscopes": [
    {
      "scope": "user:name",
      "accessscopes": [
        "organization:owner",
        "organization:member"
      ]
    },
    {
      "scope": "user:email:personal email",
      "accessscopes": [
        "organization:owner"
      ]
    }
  ],
  "includesuborgsof": [
    "organization2"
  ]
}

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

Create a new suborganization.

Secured by oauth_2_0 with scopes:

organization:owner

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

globalid: required (string)

Body

Media type: application/json

Type: object

Properties

globalid: required (string - minLength: 3 - maxLength: 150 - pattern: ^[a-z\d\-_\s]{3,150}$)
publicKeys: required (array of )
dns: required (array of )
List of organization DNS.
owners: required (array of )
List of users usernames.
members: required (array of )
List of users who are member in this organization.
orgowners: required (array of )
List of other organizations who act as an owner in this organization.
orgmembers: required (array of )
List of other organizations who act as a member in this organization.
includes: required (array of )
globalId of sub organizations
requiredscopes: required (array of RequiredScope)
List of scopes that are required to join this organization
Items: RequiredScope
- scope: required (string - maxLength: 1024)
  Scope which should be shared with an organization
- accessscopes: required (array of )
  Which users can see the shared information.
includesuborgsof: required (array of )
List of orgowners and orgmembers who's children should be included in the organizations membershi or ownership hierarchy

Example:

{
  "globalid": "greenitglobe",
  "publicKeys": [
    "1A9WWh6iAE4RZGN7axy6xZbuWuLknqWLrV"
  ],
  "dns": [
    "greenitglobe.com"
  ],
  "owners": [
    "user1",
    "user2",
    "user3"
  ],
  "members": [
    "user4"
  ],
  "orgowners": [
    "organization1"
  ],
  "orgmembers": [
    "organization2",
    "organization3"
  ],
  "includes": [
    "admin.greenitglobe.com"
  ],
  "requiredscopes": [
    {
      "scope": "user:name",
      "accessscopes": [
        "organization:owner",
        "organization:member"
      ]
    },
    {
      "scope": "user:email:personal email",
      "accessscopes": [
        "organization:owner"
      ]
    }
  ],
  "includesuborgsof": [
    "organization2"
  ]
}

HTTP status code 201

Body

Media type: application/json

Type: object

Properties

globalid: required (string - minLength: 3 - maxLength: 150 - pattern: ^[a-z\d\-_\s]{3,150}$)
publicKeys: required (array of )
dns: required (array of )
List of organization DNS.
owners: required (array of )
List of users usernames.
members: required (array of )
List of users who are member in this organization.
orgowners: required (array of )
List of other organizations who act as an owner in this organization.
orgmembers: required (array of )
List of other organizations who act as a member in this organization.
includes: required (array of )
globalId of sub organizations
requiredscopes: required (array of RequiredScope)
List of scopes that are required to join this organization
Items: RequiredScope
- scope: required (string - maxLength: 1024)
  Scope which should be shared with an organization
- accessscopes: required (array of )
  Which users can see the shared information.
includesuborgsof: required (array of )
List of orgowners and orgmembers who's children should be included in the organizations membershi or ownership hierarchy

Example:

{
  "globalid": "greenitglobe",
  "publicKeys": [
    "1A9WWh6iAE4RZGN7axy6xZbuWuLknqWLrV"
  ],
  "dns": [
    "greenitglobe.com"
  ],
  "owners": [
    "user1",
    "user2",
    "user3"
  ],
  "members": [
    "user4"
  ],
  "orgowners": [
    "organization1"
  ],
  "orgmembers": [
    "organization2",
    "organization3"
  ],
  "includes": [
    "admin.greenitglobe.com"
  ],
  "requiredscopes": [
    {
      "scope": "user:name",
      "accessscopes": [
        "organization:owner",
        "organization:member"
      ]
    },
    {
      "scope": "user:email:personal email",
      "accessscopes": [
        "organization:owner"
      ]
    }
  ],
  "includesuborgsof": [
    "organization2"
  ]
}

HTTP status code 404

Parent organization does not exist

Body

Media type: application/json

Type: object

Properties

error: required (string)

HTTP status code 422

Maximum amount of organizations reached

Body

Media type: application/json

Type: object

Properties

error: required (string)

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/organizations/{globalid}/logo get put delete

get

Get the Logo from an organization

put

Set the organization Logo for the organization

delete

Removes the Logo from an organization

/organizations/{globalid}/orgmembers post put

post

Add another organization as a member of this one

put

Update the membership status of an organization

Secured by oauth_2_0 with scopes:

organization:owner

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

globalid: required (string)

Body

Media type: application/json

Type: object

Properties

org: required (string)
role: required (string)

HTTP status code 200

updated organization membership successfully

Body

Media type: application/json

Type: object

Properties

globalid: required (string - minLength: 3 - maxLength: 150 - pattern: ^[a-z\d\-_\s]{3,150}$)
publicKeys: required (array of )
dns: required (array of )
List of organization DNS.
owners: required (array of )
List of users usernames.
members: required (array of )
List of users who are member in this organization.
orgowners: required (array of )
List of other organizations who act as an owner in this organization.
orgmembers: required (array of )
List of other organizations who act as a member in this organization.
includes: required (array of )
globalId of sub organizations
requiredscopes: required (array of RequiredScope)
List of scopes that are required to join this organization
Items: RequiredScope
- scope: required (string - maxLength: 1024)
  Scope which should be shared with an organization
- accessscopes: required (array of )
  Which users can see the shared information.
includesuborgsof: required (array of )
List of orgowners and orgmembers who's children should be included in the organizations membershi or ownership hierarchy

Example:

{
  "globalid": "greenitglobe",
  "publicKeys": [
    "1A9WWh6iAE4RZGN7axy6xZbuWuLknqWLrV"
  ],
  "dns": [
    "greenitglobe.com"
  ],
  "owners": [
    "user1",
    "user2",
    "user3"
  ],
  "members": [
    "user4"
  ],
  "orgowners": [
    "organization1"
  ],
  "orgmembers": [
    "organization2",
    "organization3"
  ],
  "includes": [
    "admin.greenitglobe.com"
  ],
  "requiredscopes": [
    {
      "scope": "user:name",
      "accessscopes": [
        "organization:owner",
        "organization:member"
      ]
    },
    {
      "scope": "user:email:personal email",
      "accessscopes": [
        "organization:owner"
      ]
    }
  ],
  "includesuborgsof": [
    "organization2"
  ]
}

HTTP status code 404

Organization not found

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/organizations/{globalid}/orgmembers/includesuborgs post

post

Add an orgmember or orgowner organization to the includesuborgsof list

Secured by oauth_2_0 with scopes:

organization:owner

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

globalid: required (string)

Body

Media type: application/json

Type: object

Properties

globalid: required (string)

HTTP status code 201

organization addedd successfully

Body

Media type: application/json

Type: object

Properties

globalid: required (string - minLength: 3 - maxLength: 150 - pattern: ^[a-z\d\-_\s]{3,150}$)
publicKeys: required (array of )
dns: required (array of )
List of organization DNS.
owners: required (array of )
List of users usernames.
members: required (array of )
List of users who are member in this organization.
orgowners: required (array of )
List of other organizations who act as an owner in this organization.
orgmembers: required (array of )
List of other organizations who act as a member in this organization.
includes: required (array of )
globalId of sub organizations
requiredscopes: required (array of RequiredScope)
List of scopes that are required to join this organization
Items: RequiredScope
- scope: required (string - maxLength: 1024)
  Scope which should be shared with an organization
- accessscopes: required (array of )
  Which users can see the shared information.
includesuborgsof: required (array of )
List of orgowners and orgmembers who's children should be included in the organizations membershi or ownership hierarchy

Example:

{
  "globalid": "greenitglobe",
  "publicKeys": [
    "1A9WWh6iAE4RZGN7axy6xZbuWuLknqWLrV"
  ],
  "dns": [
    "greenitglobe.com"
  ],
  "owners": [
    "user1",
    "user2",
    "user3"
  ],
  "members": [
    "user4"
  ],
  "orgowners": [
    "organization1"
  ],
  "orgmembers": [
    "organization2",
    "organization3"
  ],
  "includes": [
    "admin.greenitglobe.com"
  ],
  "requiredscopes": [
    {
      "scope": "user:name",
      "accessscopes": [
        "organization:owner",
        "organization:member"
      ]
    },
    {
      "scope": "user:email:personal email",
      "accessscopes": [
        "organization:owner"
      ]
    }
  ],
  "includesuborgsof": [
    "organization2"
  ]
}

HTTP status code 404

Organization not found

HTTP status code 409

Organization is already in the list

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/organizations/{globalid}/organizations/{invitingorg}/roles/{role} post delete

post

Accept the invite for one of your organizations

delete

Reject the invite for one of your organizations

Accept the invite for one of your organizations

Secured by oauth_2_0 with scopes:

organization:owner

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

globalid: required (string)
invitingorg: required (string)
role: required (string)

Body

Media type: application/json

Type: object

Properties

organization: required (string)
user: required (string)
role: required (one of owner, member, orgowner, orgmember)
created: (datetime)
status: required (one of pending, accepted, rejected)
method: required (one of website, email, phone)
emailaddress: required (string)
phonenumber: required (string)
isorganization: required (boolean)

Example:

{
  "organization": "mycoolsoccerclub",
  "user": "bob",
  "role": "owner",
  "created": "2016-02-28T16:41:41.090Z",
  "status": "pending",
  "method": "website",
  "emailaddress": "",
  "phonenumber": "",
  "isorganization": false
}

HTTP status code 201

Invite accepted

Body

Media type: application/json

Type: object

Properties

organization: required (string)
user: required (string)
role: required (one of owner, member, orgowner, orgmember)
created: (datetime)
status: required (one of pending, accepted, rejected)
method: required (one of website, email, phone)
emailaddress: required (string)
phonenumber: required (string)
isorganization: required (boolean)

Example:

{
  "organization": "mycoolsoccerclub",
  "user": "bob",
  "role": "owner",
  "created": "2016-02-28T16:41:41.090Z",
  "status": "pending",
  "method": "website",
  "emailaddress": "",
  "phonenumber": "",
  "isorganization": false
}

HTTP status code 404

Invite not found

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/organizations/{globalid}/members put post

put

Update an organization membership

post

Invite someone to become member of an organization.

Update an organization membership

Secured by oauth_2_0 with scopes:

organization:owner

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

globalid: required (string)

Body

Media type: application/json

Type: object

Properties

username: required (string)
role: required (string)

HTTP status code 200

updated successfully

Body

Media type: application/json

Type: object

Properties

globalid: required (string - minLength: 3 - maxLength: 150 - pattern: ^[a-z\d\-_\s]{3,150}$)
publicKeys: required (array of )
dns: required (array of )
List of organization DNS.
owners: required (array of )
List of users usernames.
members: required (array of )
List of users who are member in this organization.
orgowners: required (array of )
List of other organizations who act as an owner in this organization.
orgmembers: required (array of )
List of other organizations who act as a member in this organization.
includes: required (array of )
globalId of sub organizations
requiredscopes: required (array of RequiredScope)
List of scopes that are required to join this organization
Items: RequiredScope
- scope: required (string - maxLength: 1024)
  Scope which should be shared with an organization
- accessscopes: required (array of )
  Which users can see the shared information.
includesuborgsof: required (array of )
List of orgowners and orgmembers who's children should be included in the organizations membershi or ownership hierarchy

Example:

{
  "globalid": "greenitglobe",
  "publicKeys": [
    "1A9WWh6iAE4RZGN7axy6xZbuWuLknqWLrV"
  ],
  "dns": [
    "greenitglobe.com"
  ],
  "owners": [
    "user1",
    "user2",
    "user3"
  ],
  "members": [
    "user4"
  ],
  "orgowners": [
    "organization1"
  ],
  "orgmembers": [
    "organization2",
    "organization3"
  ],
  "includes": [
    "admin.greenitglobe.com"
  ],
  "requiredscopes": [
    {
      "scope": "user:name",
      "accessscopes": [
        "organization:owner",
        "organization:member"
      ]
    },
    {
      "scope": "user:email:personal email",
      "accessscopes": [
        "organization:owner"
      ]
    }
  ],
  "includesuborgsof": [
    "organization2"
  ]
}

HTTP status code 404

Member not found

HTTP status code 422

Maximum amount of invites reached

Body

Media type: application/json

Type: object

Properties

error: required (string)

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

Invite someone to become member of an organization.

Secured by oauth_2_0 with scopes:

organization:owner

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

globalid: required (string)

Query Parameters

invitenotification: (string)
Set to none to suppress sending an sms or email

Body

Media type: application/json

Type: object

Properties

searchstring: required (string)

HTTP status code 201

Member assigned successfully

Body

Media type: application/json

Type: object

Properties

organization: required (string)
user: required (string)
role: required (one of owner, member, orgowner, orgmember)
created: (datetime)
status: required (one of pending, accepted, rejected)
method: required (one of website, email, phone)
emailaddress: required (string)
phonenumber: required (string)
isorganization: required (boolean)

Example:

{
  "organization": "mycoolsoccerclub",
  "user": "bob",
  "role": "owner",
  "created": "2016-02-28T16:41:41.090Z",
  "status": "pending",
  "method": "website",
  "emailaddress": "",
  "phonenumber": "",
  "isorganization": false
}

HTTP status code 404

Not found

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/organizations/{globalid}/owners post

post

Invite someone to become owner of an organization.

Secured by oauth_2_0 with scopes:

organization:owner

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

globalid: required (string)

Query Parameters

invitenotification: (string)
Set to none to suppress sending an sms or email

Body

Media type: application/json

Type: object

Properties

username: required (string)
Used when assigning a member to an organization.

Example:

{
  "username": "bob"
}

HTTP status code 201

Invite created successfully

Body

Media type: application/json

Type: object

Properties

organization: required (string)
user: required (string)
role: required (one of owner, member, orgowner, orgmember)
created: (datetime)
status: required (one of pending, accepted, rejected)
method: required (one of website, email, phone)
emailaddress: required (string)
phonenumber: required (string)
isorganization: required (boolean)

Example:

{
  "organization": "mycoolsoccerclub",
  "user": "bob",
  "role": "owner",
  "created": "2016-02-28T16:41:41.090Z",
  "status": "pending",
  "method": "website",
  "emailaddress": "",
  "phonenumber": "",
  "isorganization": false
}

HTTP status code 404

The user or the organization does not exist.

HTTP status code 409

The user already is an owner.

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/organizations/{globalid}/contracts get post

get

Get the contracts where the organization is 1 of the parties. Order descending by date.

post

Create a new contract.

Secured by oauth_2_0 with scopes:

organization:owner

OAuth2 is a protocol that lets external apps request authorization to private details in a user's account without getting their password.

URI Parameters

globalid: required (string)

Body

Media type: application/json

Type: object

Properties

parties: required (array of Party)
Items: Party
- type: required (string)
- name: required (string)
content: required (string)
contractType: required (string - maxLength: 40)
Free field to be used for tags by the party creating a contract
invalidates: (array of )
list of contractId's this contract invalidates.
extends: (array of )
list of contractId's this contract is an extension upon
expires: required (datetime)
contractId: required (string)
The contractId is the hash of the parties, the content, the contractType, and the expiration date. To calculate the hash, take the json representation of the contract without the id and signatures, trim the newlines or spaces (except when they appear in the values) and encode in utf8. From this result, take a SHA256 followed by a RIPEMD160, next base58CheckEncode the result with a 0x00 prefix.
signatures: required (array of Signature)
Items: Signature
- signedBy: required (string)
- date: required (datetime)
- publicKey: required (string)
  The public key used
- signature: required (string)

HTTP status code 201

Body

Media type: application/json

Type: object

Properties

parties: required (array of Party)
Items: Party
- type: required (string)
- name: required (string)
content: required (string)
contractType: required (string - maxLength: 40)
Free field to be used for tags by the party creating a contract
invalidates: (array of )
list of contractId's this contract invalidates.
extends: (array of )
list of contractId's this contract is an extension upon
expires: required (datetime)
contractId: required (string)
The contractId is the hash of the parties, the content, the contractType, and the expiration date. To calculate the hash, take the json representation of the contract without the id and signatures, trim the newlines or spaces (except when they appear in the values) and encode in utf8. From this result, take a SHA256 followed by a RIPEMD160, next base58CheckEncode the result with a 0x00 prefix.
signatures: required (array of Signature)
Items: Signature
- signedBy: required (string)
- date: required (datetime)
- publicKey: required (string)
  The public key used
- signature: required (string)

Secured by oauth_2_0

Headers

Authorization: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "access_token" query string parameter.

Query Parameters

access_token: required (string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header

HTTP status code 401

Unauthorized

HTTP status code 403

Forbidden

/organizations/{globalid}/apikeys/{label} get put delete

get

Get an api key from an organization

put

Updates the label or other properties of a key.

delete

Removes an API key

Itsyouonline API documentation version 0.1

/users

post /users

Body

Secured by oauth_2_0

Headers

Query Parameters

HTTP status code 401

HTTP status code 403

get /users/avatar/img/{hash}

URI Parameters

HTTP status code 200

Body

HTTP status code 404

Secured by oauth_2_0

Headers

Query Parameters

HTTP status code 401

HTTP status code 403

get /users/{username}

URI Parameters

HTTP status code 200

Body

Secured by oauth_2_0

Headers

Query Parameters

HTTP status code 401

HTTP status code 403

put /users/{username}/name

URI Parameters

Body

HTTP status code 204

HTTP status code 404

Secured by oauth_2_0

Headers

Query Parameters

HTTP status code 401

HTTP status code 403

put /users/{username}/password

URI Parameters

Body

HTTP status code 204

HTTP status code 422

Body

Secured by oauth_2_0

Headers

Query Parameters

HTTP status code 401

HTTP status code 403

get /users/{username}/emailaddresses

URI Parameters

Query Parameters

HTTP status code 200

Body

Secured by oauth_2_0

Headers

Query Parameters

HTTP status code 401

HTTP status code 403

post /users/{username}/emailaddresses

URI Parameters

Query Parameters

Body

HTTP status code 201

Body

HTTP status code 409

Secured by oauth_2_0

Headers

Query Parameters

HTTP status code 401

HTTP status code 403

put /users/{username}/emailaddresses/{label}

URI Parameters

Query Parameters

Body

HTTP status code 201

HTTP status code 409

HTTP status code 412

Secured by oauth_2_0

Headers