Public TestsYour infrastructure. Help shape the future of RackDocs.Apply with your team

09 / TEAM AND INTEGRATIONS

Share documentation according to role.

Not every user needs to change infrastructure. RackDocs separates roles and client scopes, and offers controlled read access to integrations through its API.

WHAT THE ADMINISTRATOR GAINS

Match access to administrators, editors and documentation readers, and use a scoped token to retrieve data.

01 / TEAM AND INTEGRATIONS

One account can have different client roles

Viewers read documentation. Editors update infrastructure. Client administrators manage a wider range of settings and invitations. Organisation and operator administration roles serve their respective environment levels.

An account can have different permissions for different clients. Email invitations let new people join or connect existing accounts to another client. Administrators choose the role; assigning an equipment caretaker is a separate action.

Access management detail: role descriptions, assignments and a user invitation form. Click to enlarge.

02 / TEAM AND INTEGRATIONS

Protect accounts and private files

The application supports TOTP two-factor authentication and recovery codes. Environment policy can require MFA. Infrastructure files are private and require the appropriate access, as do records opened through QR labels.

RackDocs supports hosted deployment and installation on your own infrastructure with Docker. Properly configured deployments can separate organisation databases and files. Agree on access, backup and update responsibilities for the chosen deployment model.

03 / TEAM AND INTEGRATIONS

Read infrastructure data through the API

API v1 provides lists and details for clients, locations, racks, devices, ports and connections. Lists support search, filters, sorting and pagination. Cable details include both endpoints.

A token belongs to a user and has selected permissions, allowed clients and an expiry period. Token scope and current account access are checked independently. The OpenAPI specification helps build an integration without guessing the data structure.

API v1 panel detail: available GET paths and their corresponding read permissions. Click to enlarge.

04 / TEAM AND INTEGRATIONS

Match initial tests to your team

In your Public Tests application, describe location, rack, device and user counts and your preferred deployment model. This supports discussion of the real workflow: a single site, multiple branches or an integrator’s client documentation.

The programme also helps identify missing capabilities. Access and participation terms are arranged after the application. Submitting the form does not automatically create an application account or grant a licence.

Practical workflow

Share documentation with a team and an integration

  1. Assign users to the right client with roles matching their tasks.
  2. Agree on account protection and environment administration responsibilities.
  3. For an integration, select the minimum read permissions, client scope and token lifetime.
Understanding the scope

The current API is read-only: it does not create or modify infrastructure or expose the complete file and history scope. www.rackdocs.pl is a separate information and test application website.

Screenshots come from the working RackDocs application and show a demonstration environment with fictional infrastructure. They include selected views and screen details; the application is evolving. Screenshots retain the Polish interface in this English guide.

PUBLIC TESTS / TELL US ABOUT YOUR ENVIRONMENT

Try RackDocs in your own scenario.

RackDocs is in Internal final test. Apply for Public Tests and describe the infrastructure you want to organise. We will contact you about joining the public test edition.

Join Public Tests
Open full-size screenshot ↗