POST /v1/addAccessRight - BlueCat Address Manager - 9.2.0

Address Manager API Guide

Locale
English (United States)
Product name
BlueCat Address Manager
Version
9.2.0

Description

Adds access rights to a specified object.

Parameters

Name Description
entityId

Location: query

Type: integer (int64)

The object ID of the entity to which the access right is being added. Set to zero (0) if you are adding the access right to the root level default access rights.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
overrides

Location: query

Type: string

A list of type-specific overrides in the following format:
"objectType=accessValue|objectType=accessValue"
properties

Location: query

Type: string

A string including the following options:
  • workflowLevel —valid values for this option are:
    • None —changes made by the user or group take effect immediately.
    • Recommend —changes made by the user or group are saved as change requests and must be reviewed and approved before they take effect.
    • Approve —changes made by the user or group take effect immediately and the user or group can approve change requests from other users or groups.
  • deploymentAllowed —either true or false, to indicate whether or not the user or group can perform a full deployment of data from the configuration to a managed server.
  • quickDeploymentAllowed —either true or false, to indicate whether or not the user or group can instantly deploy changed DNS resource records.
Note:
  • All of these properties are optional.
  • The deploymentAllowedproperty is applicable only for configuration, server, or root with Full access rights.
  • The workflowLevelproperty is applicable only for Change, Add, or Full access rights.
userId

Location: query

Type: integer (int64)

The object ID of the user to whom this access right applies.
Note: Starting in Address Manager API v9.2.0, this parameter is now required.
value

Location: query

Type: string

The value of the access right being added. Valid values for this parameter are listed in the Access right values table.

Responses

Code Description
201

Type: number

Returns the object ID for the new access right.