Download OpenAPI specification:Download
The Platform Admin API is the core management component of the Rehive ecosystem. It provides adminsitrative access to platform resources.
User authentication (login) must still be performed via the Platform API because the Admin API only provides an interface for authenticating on behalf of users. The documentation for this can be found below:
For general usage, help, and recommendations please take a look at the platform docs.
rehive.admin.access_control_rules.get()
{- "status": "success",
- "data": {
- "count": 123,
- "results": [
- {
- "id": 0,
- "action": "allow",
- "type": "ip",
- "value": "string",
- "label": "string",
- "user": {
- "id": "string",
- "username": "string",
- "email": "user@example.com",
- "mobile": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "groups": [
- {
- "name": "string",
- "label": "string",
- "section": "system"
}
], - "temporary": true
}, - "group": {
- "name": "string",
- "label": "string",
- "section": "system"
}, - "created": 0,
- "updated": 0
}
]
}
}
{- "action": "allow",
- "type": "ip",
- "value": "string",
- "label": "string",
- "user": "string",
- "group": "string"
}
{- "status": "success",
- "data": {
- "id": 0,
- "action": "allow",
- "type": "ip",
- "value": "string",
- "label": "string",
- "user": {
- "id": "string",
- "username": "string",
- "email": "user@example.com",
- "mobile": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "groups": [
- {
- "name": "string",
- "label": "string",
- "section": "system"
}
], - "temporary": true
}, - "group": {
- "name": "string",
- "label": "string",
- "section": "system"
}, - "created": 0,
- "updated": 0
}
}
rehive.admin.access_control_rules.get( access_control_rule_id )
{- "status": "success",
- "data": {
- "id": 0,
- "action": "allow",
- "type": "ip",
- "value": "string",
- "label": "string",
- "user": {
- "id": "string",
- "username": "string",
- "email": "user@example.com",
- "mobile": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "groups": [
- {
- "name": "string",
- "label": "string",
- "section": "system"
}
], - "temporary": true
}, - "group": {
- "name": "string",
- "label": "string",
- "section": "system"
}, - "created": 0,
- "updated": 0
}
}
{- "action": "allow",
- "type": "ip",
- "value": "string",
- "label": "string",
- "user": "string",
- "group": "string"
}
{- "status": "success",
- "data": {
- "id": 0,
- "action": "allow",
- "type": "ip",
- "value": "string",
- "label": "string",
- "user": {
- "id": "string",
- "username": "string",
- "email": "user@example.com",
- "mobile": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "groups": [
- {
- "name": "string",
- "label": "string",
- "section": "system"
}
], - "temporary": true
}, - "group": {
- "name": "string",
- "label": "string",
- "section": "system"
}, - "created": 0,
- "updated": 0
}
}
{- "action": "allow",
- "type": "ip",
- "value": "string",
- "label": "string",
- "user": "string",
- "group": "string"
}
{- "status": "success",
- "data": {
- "id": 0,
- "action": "allow",
- "type": "ip",
- "value": "string",
- "label": "string",
- "user": {
- "id": "string",
- "username": "string",
- "email": "user@example.com",
- "mobile": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "groups": [
- {
- "name": "string",
- "label": "string",
- "section": "system"
}
], - "temporary": true
}, - "group": {
- "name": "string",
- "label": "string",
- "section": "system"
}, - "created": 0,
- "updated": 0
}
}