API Overview
Usecases
Cheatsheet

User Roles and Access Tokens Scopes

Dimension Four has several user roles and access token scopes.

User Roles

(Any user can create a tenant and become its owner)

Guest

Space/Point/Signal: Read

Developer

Space/Point/Signal: Read, Create, Update, Delete
Webhook: Read, Create, Update, Delete
Access Token: Read, Create, Delete
Tenant: Read

Admin

Space/Point/Signal: Read, Create, Update, Delete
Webhook: Read, Create, Update, Delete
Access Token: Read, Create, Delete
Tenant: Read, Update
Member: Read, Create, Update, Delete

Owner

Space/Point/Signal: Read, Create, Update, Delete
Webhook: Read, Create, Update, Delete
Access Token: Read, Create, Delete
Tenant: Read, Update, Delete
Member: Read, Create, Update, Delete
Billing: Read, Create, Update, Delete

Tenant membership administration

With the role OWNER or ADMIN, you can invite new members to the tenant.

Every tenant-specific GraphQL operation requires following HTTP header:

{ "x-tenant-id": "tenant-id" } // e.g. company-name
mutation ADD_USER {
member {
invite(input: { email: "name@company.com", role: DEVELOPER }) {
id
email
role
}
}
}

Invited member should receive an email with verification token.

mutation ACCEPT_MEMBERSHIP{
member{
accept(input:{token:"verification-token"}) {
id
email
userId
tenant {
name
}
}
}
}

Tenant membership and roles:

query TENANT_MEMBERS {
tenants {
id
members {
id
email
role
}
}
}

Ready to get started?