Rehive logo
Powered by Redocly

groups

List groups

SecurityapiAuth
Request
query Parameters
archived
boolean
created
string <date-time>
created__gt
string <date-time>
created__lt
string <date-time>
default
boolean
name
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

public
boolean
section
string
updated
string <date-time>
updated__gt
string <date-time>
updated__lt
string <date-time>
Responses
200
get/3/admin/groups/
Request samples 
rehive.admin.groups.get().then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Create group

SecurityapiAuth
Request
Request Body schema:
required
name
required
string <= 80 characters
label
string or null <= 80 characters
description
string or null <= 255 characters
icon
string or null <uri>
section
string
  • admin - Admin
  • user - User
Enum: "admin" "user"
default
boolean
public
boolean
listed
boolean
Responses
201
post/3/admin/groups/
Request samples
{
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "icon": "http://example.com",
  • "section": "admin",
  • "default": true,
  • "public": true,
  • "listed": true
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve group

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

Update group

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
Request Body schema:
required
name
required
string <= 80 characters
label
string or null <= 80 characters
description
string or null <= 255 characters
icon
string or null <uri>
section
string
  • system - System
  • admin - Admin
  • user - User
Enum: "system" "admin" "user"
default
required
boolean
public
required
boolean
listed
required
boolean
archived
boolean
Default: false
Responses
200
put/3/admin/groups/{group_name}/
Request samples
{
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "icon": "http://example.com",
  • "section": "system",
  • "default": true,
  • "public": true,
  • "listed": true,
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update group

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
Request Body schema:
name
string <= 80 characters
label
string or null <= 80 characters
description
string or null <= 255 characters
icon
string or null <uri>
section
string
  • system - System
  • admin - Admin
  • user - User
Enum: "system" "admin" "user"
default
boolean
public
boolean
listed
boolean
archived
boolean
Default: false
Responses
200
patch/3/admin/groups/{group_name}/
Request samples
{
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "icon": "http://example.com",
  • "section": "system",
  • "default": true,
  • "public": true,
  • "listed": true,
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

List group fees

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
Responses
200
get/3/admin/groups/{group_name}/fees/
Request samples 
rehive.admin.groups.obj(group_name).fees.get()
Response samples
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Create group fee

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
Request Body schema:
required
name
string or null <= 50 characters
value
integer >= 0
percentage
number <double> [ 0 .. 1000 )
tx_type
required
string
  • credit - Credit
  • debit - Debit
Enum: "credit" "debit"
subtype
string or null
description
string or null <= 250 characters
debit_account
string or null
credit_account
string or null
debit_subtype
string or null
credit_subtype
string or null
inferred
boolean
account_definition
string or null
currency
required
string
Responses
201
post/3/admin/groups/{group_name}/fees/
Request samples
{
  • "name": "string",
  • "value": 0,
  • "percentage": 0,
  • "tx_type": "credit",
  • "subtype": "string",
  • "description": "string",
  • "debit_account": "string",
  • "credit_account": "string",
  • "debit_subtype": "string",
  • "credit_subtype": "string",
  • "inferred": true,
  • "account_definition": "string",
  • "currency": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve group fee

SecurityapiAuth
Request
path Parameters
fee_id
required
string^\d+$
group_name
required
string^\w+$
Responses
200
get/3/admin/groups/{group_name}/fees/{fee_id}/
Request samples 
rehive.admin.groups.obj(group_name).fees.create(
  tx_type="debit",
  currency="USD"
)
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

update group fee

SecurityapiAuth
Request
path Parameters
fee_id
required
string^\d+$
group_name
required
string^\w+$
Request Body schema:
required
name
string or null <= 50 characters
value
integer >= 0
percentage
number <double> [ 0 .. 1000 )
tx_type
required
string
  • credit - Credit
  • debit - Debit
Enum: "credit" "debit"
subtype
string or null
description
string or null <= 250 characters
debit_account
string or null
credit_account
string or null
debit_subtype
string or null
credit_subtype
string or null
inferred
boolean
account_definition
string or null
currency
string
archived
boolean
Default: false
Responses
200
put/3/admin/groups/{group_name}/fees/{fee_id}/
Request samples
{
  • "name": "string",
  • "value": 0,
  • "percentage": 0,
  • "tx_type": "credit",
  • "subtype": "string",
  • "description": "string",
  • "debit_account": "string",
  • "credit_account": "string",
  • "debit_subtype": "string",
  • "credit_subtype": "string",
  • "inferred": true,
  • "account_definition": "string",
  • "currency": "string",
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially group fee

SecurityapiAuth
Request
path Parameters
fee_id
required
string^\d+$
group_name
required
string^\w+$
Request Body schema:
name
string or null <= 50 characters
value
integer >= 0
percentage
number <double> [ 0 .. 1000 )
tx_type
string
  • credit - Credit
  • debit - Debit
Enum: "credit" "debit"
subtype
string or null
description
string or null <= 250 characters
debit_account
string or null
credit_account
string or null
debit_subtype
string or null
credit_subtype
string or null
inferred
boolean
account_definition
string or null
currency
string
archived
boolean
Default: false
Responses
200
patch/3/admin/groups/{group_name}/fees/{fee_id}/
Request samples
{
  • "name": "string",
  • "value": 0,
  • "percentage": 0,
  • "tx_type": "credit",
  • "subtype": "string",
  • "description": "string",
  • "debit_account": "string",
  • "credit_account": "string",
  • "debit_subtype": "string",
  • "credit_subtype": "string",
  • "inferred": true,
  • "account_definition": "string",
  • "currency": "string",
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete group fee

SecurityapiAuth
Request
path Parameters
fee_id
required
string^\d+$
group_name
required
string^\w+$
Responses
200
delete/3/admin/groups/{group_name}/fees/{fee_id}/
Request samples 
rehive.admin.groups.obj(group_name).fees.delete(
  fees_id
)
Response samples
application/json
{
  • "status": "sucess"
}

List group permissions

SecurityapiAuth
Request
path Parameters
group_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/groups/{group_name}/permissions/
Request samples 
rehive.admin.groups.permissions.get(groupName)
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{}

Create group permission

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
Request Body schema:
required
required
Array of objects (AdminCreateGroupPermission)
Responses
201
post/3/admin/groups/{group_name}/permissions/
Request samples
{
  • "permissions": [
    ]
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve group permission

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
permission_id
required
string^\d+$
Responses
200
get/3/admin/groups/{group_name}/permissions/{permission_id}/
Request samples 
rehive.admin.groups.permissions
.get(group_name, {"id": permissionId}).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update group permission

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
permission_id
required
string^\d+$
Request Body schema:
object or null
Responses
200
put/3/admin/groups/{group_name}/permissions/{permission_id}/
Request samples
{
  • "properties": {
    }
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update group permission

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
permission_id
required
string^\d+$
Request Body schema:
object or null
Responses
200
patch/3/admin/groups/{group_name}/permissions/{permission_id}/
Request samples
{
  • "properties": {
    }
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete group permission

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
permission_id
required
string^\d+$
Responses
200
delete/3/admin/groups/{group_name}/permissions/{permission_id}/
Request samples 
rehive.admin.groups.permissions
.delete(group_name, permissionId).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "sucess"
}

Retrieve group settings

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
Responses
200
get/3/admin/groups/{group_name}/settings/
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update group settings

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
Request Body schema:
required
allow_transactions
boolean
allow_debit_transactions
boolean
allow_credit_transactions
boolean
required
Array of objects (UpdateGroupDisallowedTransactionSubtype)
password_reset_url
string or null <uri> <= 200 characters
password_set_url
string or null <uri> <= 200 characters
email_verification_url
string or null <uri> <= 200 characters
deactivate_verification_url
string or null <uri> <= 200 characters
request_delete_verification_url
string or null <uri> <= 200 characters
Responses
200
put/3/admin/groups/{group_name}/settings/
Request samples
{}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update group settings

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
Request Body schema:
allow_transactions
boolean
allow_debit_transactions
boolean
allow_credit_transactions
boolean
Array of objects (UpdateGroupDisallowedTransactionSubtype)
password_reset_url
string or null <uri> <= 200 characters
password_set_url
string or null <uri> <= 200 characters
email_verification_url
string or null <uri> <= 200 characters
deactivate_verification_url
string or null <uri> <= 200 characters
request_delete_verification_url
string or null <uri> <= 200 characters
Responses
200
patch/3/admin/groups/{group_name}/settings/
Request samples
{}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

List group tiers

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
query Parameters
active
boolean
level
integer
requirement
string
Responses
200
get/3/admin/groups/{group_name}/tiers/
Request samples 
rehive.admin.groups.tiers.get(groupName)
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Create group tiers

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
Request Body schema:
required
level
required
integer [ -2147483648 .. 2147483647 ]
name
string or null <= 255 characters
description
string or null <= 255 characters
Responses
201
post/3/admin/groups/{group_name}/tiers/
Request samples
{
  • "level": -2147483648,
  • "name": "string",
  • "description": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve group tiers

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
tier_id
required
string^\d+$
Responses
200
get/3/admin/groups/{group_name}/tiers/{tier_id}/
Request samples 
rehive.admin.groups.tiers.get(groupName, {"id": tierId})
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update group tiers

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
tier_id
required
string^\d+$
Request Body schema:
required
level
required
integer [ -2147483648 .. 2147483647 ]
name
string or null <= 255 characters
description
string or null <= 255 characters
archived
boolean
Default: false
Responses
200
put/3/admin/groups/{group_name}/tiers/{tier_id}/
Request samples
{
  • "level": -2147483648,
  • "name": "string",
  • "description": "string",
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update group tiers

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
tier_id
required
string^\d+$
Request Body schema:
level
integer [ -2147483648 .. 2147483647 ]
name
string or null <= 255 characters
description
string or null <= 255 characters
archived
boolean
Default: false
Responses
200
patch/3/admin/groups/{group_name}/tiers/{tier_id}/
Request samples
{
  • "level": -2147483648,
  • "name": "string",
  • "description": "string",
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete group tiers

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
tier_id
required
string^\d+$
Responses
200
delete/3/admin/groups/{group_name}/tiers/{tier_id}/
Request samples 
rehive.admin.groups.tiers.delete(groupName, tierId)
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "sucess"
}

List group tier fees

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
tier_id
required
string^\d+$
Responses
200
get/3/admin/groups/{group_name}/tiers/{tier_id}/fees/
Request samples 
rehive.admin.groups.tiers.fees.get(groupName, tierId)
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Create group tier fees

SecurityapiAuth
Request
path Parameters
group_name
required
string^\w+$
tier_id
required
string^\d+$
Request Body schema:
required
name
string or null <= 50 characters
value
integer >= 0
percentage
number <double> [ 0 .. 1000 )
tx_type
required
string
  • credit - Credit
  • debit - Debit
Enum: "credit" "debit"
subtype
string or null
description
string or null <= 250 characters
debit_account
string or null
credit_account
string or null
debit_subtype
string or null
credit_subtype
string or null
inferred
boolean
account_definition
string or null
currency
required
string
Responses
201
post/3/admin/groups/{group_name}/tiers/{tier_id}/fees/
Request samples
{
  • "name": "string",
  • "value": 0,
  • "percentage": 0,
  • "tx_type": "credit",
  • "subtype": "string",
  • "description": "string",
  • "debit_account": "string",
  • "credit_account": "string",
  • "debit_subtype": "string",
  • "credit_subtype": "string",
  • "inferred": true,
  • "account_definition": "string",
  • "currency": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve group tier fee

SecurityapiAuth
Request
path Parameters
fee_id
required
string^\d+$
group_name
required
string^\w+$
tier_id
required
string^\d+$
Responses
200
get/3/admin/groups/{group_name}/tiers/{tier_id}/fees/{fee_id}/
Request samples 
rehive.admin.groups.tiers.fees.get(
  group_name, tier_id, {"id": feeId}).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update group tier fee

SecurityapiAuth
Request
path Parameters
fee_id
required
string^\d+$
group_name
required
string^\w+$
tier_id
required
string^\d+$
Request Body schema:
required
name
string or null <= 50 characters
value
integer >= 0
percentage
number <double> [ 0 .. 1000 )
tx_type
required
string
  • credit - Credit
  • debit - Debit
Enum: "credit" "debit"
subtype
string or null
description
string or null <= 250 characters
debit_account
string or null
credit_account
string or null
debit_subtype
string or null
credit_subtype
string or null
inferred
boolean
account_definition
string or null
currency
string
archived
boolean
Default: false
Responses
200
put/3/admin/groups/{group_name}/tiers/{tier_id}/fees/{fee_id}/
Request samples
{
  • "name": "string",
  • "value": 0,
  • "percentage": 0,
  • "tx_type": "credit",
  • "subtype": "string",
  • "description": "string",
  • "debit_account": "string",
  • "credit_account": "string",
  • "debit_subtype": "string",
  • "credit_subtype": "string",
  • "inferred": true,
  • "account_definition": "string",
  • "currency": "string",
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update group tier fee

SecurityapiAuth
Request
path Parameters
fee_id
required
string^\d+$
group_name
required
string^\w+$
tier_id
required
string^\d+$
Request Body schema:
name
string or null <= 50 characters
value
integer >= 0
percentage
number <double> [ 0 .. 1000 )
tx_type
string
  • credit - Credit
  • debit - Debit
Enum: "credit" "debit"
subtype
string or null
description
string or null <= 250 characters
debit_account
string or null
credit_account
string or null
debit_subtype
string or null
credit_subtype
string or null
inferred
boolean
account_definition
string or null
currency
string
archived
boolean
Default: false
Responses
200
patch/3/admin/groups/{group_name}/tiers/{tier_id}/fees/{fee_id}/
Request samples
{
  • "name": "string",
  • "value": 0,
  • "percentage": 0,
  • "tx_type": "credit",
  • "subtype": "string",
  • "description": "string",
  • "debit_account": "string",
  • "credit_account": "string",
  • "debit_subtype": "string",
  • "credit_subtype": "string",
  • "inferred": true,
  • "account_definition": "string",
  • "currency": "string",
  • "archived": false
}
Response samples