Access Modes

Permission presets for a database

For more information read our section on Access Modes​
To set per user permissions read our section on Access Policies​
​
setAccessMode
Sets the database's Access Mode.
Parameters
deploymentId (string): The database deployment id
accessMode (AccessMode): Access mode 
Example
Request
Response
Error
const response = await cedalioSdk.setAccessMode({
  deploymentId: 'Your deployment id',
  accessMode: 'PUBLIC_READ'
});
{
  ok: true,
  status: 200,
  data: {}
}
{
  ok: false,
  status: 401,
  error: {
    message: 'The error log',
    payload: {}
  }
}
getAccessMode
Get the database's Access Mode.
Parameters
deploymentId (string): The database deployment id
Example
Request
Response
Error
const response = await cedalioSdk.getAccessMode({
  accessMode: 'PUBLIC_READ'
});
{
  ok: true,
  status: 200,
  data: {
    accessMode: 'PRIVATE'
  }
}
{
  ok: false,
  status: 401,
  error: {
    message: 'The error log',
    payload: {}
  }
}
​

Database management

Access Policies

Last modified 2mo ago

Access Modes

​

setAccessMode

Parameters

Example

getAccessMode

Parameters

Example