Rehive logo
Powered by Redocly

account-definitions

List account definitions

SecurityapiAuth
Request
query Parameters
archived
boolean
created
string <date-time>
created__gt
string <date-time>
created__gte
string <date-time>
created__lt
string <date-time>
created__lte
string <date-time>
group
string
orderby
Array of strings

Ordering

  • created - Created
  • -created - Created (descending)
  • name - Name
  • -name - Name (descending)
Items Enum: "-created" "-name" "created" "name"
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/3/admin/account-definitions/
Request samples 
rehive.admin.account.definitions.get().then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create account definitions

SecurityapiAuth
Request
Request Body schema:
required
name
required
string <= 200 characters
label
string or null <= 200 characters
recon
boolean
archived
boolean
Default: false
Responses
201
post/3/admin/account-definitions/
Request samples
{
  • "name": "string",
  • "label": "string",
  • "recon": true,
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve account definition

SecurityapiAuth
Request
path Parameters
definition_name
required
string^\w+$
Responses
200
get/3/admin/account-definitions/{definition_name}/
Request samples 
rehive.admin.account_definitions.get({
  "name": accountDefinitionName
}).then( function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Updated account definition

SecurityapiAuth
Request
path Parameters
definition_name
required
string^\w+$
Request Body schema:
required
name
required
string <= 200 characters
label
string or null <= 200 characters
recon
boolean
archived
boolean
Default: false
Responses
200
put/3/admin/account-definitions/{definition_name}/
Request samples
{
  • "name": "string",
  • "label": "string",
  • "recon": true,
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update account definition

SecurityapiAuth
Request
path Parameters
definition_name
required
string^\w+$
Request Body schema:
name
string <= 200 characters
label
string or null <= 200 characters
recon
boolean
archived
boolean
Default: false
Responses
200
patch/3/admin/account-definitions/{definition_name}/
Request samples
{
  • "name": "string",
  • "label": "string",
  • "recon": true,
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

List account definitions groups

SecurityapiAuth
Request
path Parameters
definition_name
required
string^\w+$
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/3/admin/account-definitions/{definition_name}/groups/
Request samples 
rehive.admin.account.definitions.groups.get(accountDefinitionName)
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create account definitions

SecurityapiAuth
Request
path Parameters
definition_name
required
string^\w+$
Request Body schema:
required
group
required
string
default
boolean
primary
boolean
currencies
Array of strings
archived
boolean
Default: false
Responses
201
post/3/admin/account-definitions/{definition_name}/groups/
Request samples
{
  • "group": "string",
  • "default": true,
  • "primary": true,
  • "currencies": [
    ],
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve account definitions group

SecurityapiAuth
Request
path Parameters
definition_group_name
required
string^\w+$
definition_name
required
string^\w+$
Responses
200
get/3/admin/account-definitions/{definition_name}/groups/{definition_group_name}/
Request samples 
rehive.admin.account.definitions.groups.get(
accountDefinitionName, {"name": groupName}).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update account definitions group

SecurityapiAuth
Request
path Parameters
definition_group_name
required
string^\w+$
definition_name
required
string^\w+$
Request Body schema:
default
boolean
primary
boolean
currencies
Array of strings
archived
boolean
Default: false
Responses
200
put/3/admin/account-definitions/{definition_name}/groups/{definition_group_name}/
Request samples
{
  • "default": true,
  • "primary": true,
  • "currencies": [
    ],
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update account definitions group

SecurityapiAuth
Request
path Parameters
definition_group_name
required
string^\w+$
definition_name
required
string^\w+$
Request Body schema:
default
boolean
primary
boolean
currencies
Array of strings
archived
boolean
Default: false
Responses
200
patch/3/admin/account-definitions/{definition_name}/groups/{definition_group_name}/
Request samples
{
  • "default": true,
  • "primary": true,
  • "currencies": [
    ],
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

List account definition group currencies

SecurityapiAuth
Request
path Parameters
definition_group_name
required
string^\w+$
definition_name
required
string^\w+$
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses
200
get/3/admin/account-definitions/{definition_name}/groups/{definition_group_name}/currencies/
Request samples 
rehive.admin.account.definitions.groups.currencies.get(
  accountDefinitionName, groupName).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{}

Create account deffinition group currency

SecurityapiAuth
Request
path Parameters
definition_group_name
required
string^\w+$
definition_name
required
string^\w+$
Request Body schema:
required
currency
required
string
archived
boolean
Default: false
Responses
201
post/3/admin/account-definitions/{definition_name}/groups/{definition_group_name}/currencies/
Request samples
{
  • "currency": "string",
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve account definition group currency

SecurityapiAuth
Request
path Parameters
currency_code
required
string^\w+$
definition_group_name
required
string^\w+$
definition_name
required
string^\w+$
Responses
200
get/3/admin/account-definitions/{definition_name}/groups/{definition_group_name}/currencies/{currency_code}/
Request samples 
rehive.admin.account.definitions.groups.currencies(
accountDefinitionName, groupName, {
  "code": currencyCode
}).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update account definition group currency

SecurityapiAuth
Request
path Parameters
currency_code
required
string^\w+$
definition_group_name
required
string^\w+$
definition_name
required
string^\w+$
Request Body schema:
archived
boolean
Default: false
Responses
200
put/3/admin/account-definitions/{definition_name}/groups/{definition_group_name}/currencies/{currency_code}/
Request samples
{
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update account definition group currency

SecurityapiAuth
Request
path Parameters
currency_code
required
string^\w+$
definition_group_name
required
string^\w+$
definition_name
required
string^\w+$
Request Body schema:
archived
boolean
Default: false
Responses
200
patch/3/admin/account-definitions/{definition_name}/groups/{definition_group_name}/currencies/{currency_code}/
Request samples
{
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}
➔ Next to accounts