role

Get all roles

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get roles. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

Responses
200

Success

400

Bad request

403

Forbidden access

get/roles
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create role

Securityapi_key
Request
Request Body schema: application/json
required

The role to create

roleName
required
string <= 255 characters

The name for this Role. Note that it must be unique.

object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
Responses
201

Success

400

Bad request

401

Unauthorized access

404

Not found

409

Conflict

post/roles
Request samples
application/json
{
  • "roleName": "NewRole",
  • "environment": {
    },
  • "connector": {
    },
  • "ruleset": {
    },
  • "inventory": {
    },
  • "profileJob": {
    },
  • "maskingJob": {
    },
  • "tokenizeJob": {
    },
  • "reidentifyJob": {
    },
  • "domain": {
    },
  • "algorithm": {
    },
  • "jdbcDriver": {
    },
  • "passwordVault": {
    },
  • "plugin": {
    },
  • "classifier": {
    },
  • "profileSet": {
    },
  • "fileFormat": {
    },
  • "user": {
    },
  • "diagnostic": {
    },
  • "inventoryReport": {
    },
  • "approveInventories": {
    }
}
Response samples
application/json
{
  • "roleName": "NewRole",
  • "environment": {
    },
  • "connector": {
    },
  • "ruleset": {
    },
  • "inventory": {
    },
  • "profileJob": {
    },
  • "maskingJob": {
    },
  • "tokenizeJob": {
    },
  • "reidentifyJob": {
    },
  • "domain": {
    },
  • "algorithm": {
    },
  • "jdbcDriver": {
    },
  • "passwordVault": {
    },
  • "plugin": {
    },
  • "classifier": {
    },
  • "profileSet": {
    },
  • "fileFormat": {
    },
  • "user": {
    },
  • "diagnostic": {
    },
  • "inventoryReport": {
    },
  • "approveInventories": {
    }
}

Get role by ID

Securityapi_key
Request
path Parameters
roleId
required
integer <int32>

The ID of the role to get

Responses
200

Success

403

Forbidden access

404

Not found

get/roles/{roleId}
Response samples
application/json
{
  • "roleName": "NewRole",
  • "environment": {
    },
  • "connector": {
    },
  • "ruleset": {
    },
  • "inventory": {
    },
  • "profileJob": {
    },
  • "maskingJob": {
    },
  • "tokenizeJob": {
    },
  • "reidentifyJob": {
    },
  • "domain": {
    },
  • "algorithm": {
    },
  • "jdbcDriver": {
    },
  • "passwordVault": {
    },
  • "plugin": {
    },
  • "classifier": {
    },
  • "profileSet": {
    },
  • "fileFormat": {
    },
  • "user": {
    },
  • "diagnostic": {
    },
  • "inventoryReport": {
    },
  • "approveInventories": {
    }
}

Update role by ID

Securityapi_key
Request
path Parameters
roleId
required
integer <int32>

The ID of the role to update

Request Body schema: application/json
required

The updated role

roleName
required
string <= 255 characters

The name for this Role. Note that it must be unique.

object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
object (Privilege)
Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

409

Conflict

put/roles/{roleId}
Request samples
application/json
{
  • "roleName": "NewRole",
  • "environment": {
    },
  • "connector": {
    },
  • "ruleset": {
    },
  • "inventory": {
    },
  • "profileJob": {
    },
  • "maskingJob": {
    },
  • "tokenizeJob": {
    },
  • "reidentifyJob": {
    },
  • "domain": {
    },
  • "algorithm": {
    },
  • "jdbcDriver": {
    },
  • "passwordVault": {
    },
  • "plugin": {
    },
  • "classifier": {
    },
  • "profileSet": {
    },
  • "fileFormat": {
    },
  • "user": {
    },
  • "diagnostic": {
    },
  • "inventoryReport": {
    },
  • "approveInventories": {
    }
}
Response samples
application/json
{
  • "roleName": "NewRole",
  • "environment": {
    },
  • "connector": {
    },
  • "ruleset": {
    },
  • "inventory": {
    },
  • "profileJob": {
    },
  • "maskingJob": {
    },
  • "tokenizeJob": {
    },
  • "reidentifyJob": {
    },
  • "domain": {
    },
  • "algorithm": {
    },
  • "jdbcDriver": {
    },
  • "passwordVault": {
    },
  • "plugin": {
    },
  • "classifier": {
    },
  • "profileSet": {
    },
  • "fileFormat": {
    },
  • "user": {
    },
  • "diagnostic": {
    },
  • "inventoryReport": {
    },
  • "approveInventories": {
    }
}

Delete role by ID

Securityapi_key
Request
path Parameters
roleId
required
integer <int32>

The ID of the role to delete

Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

delete/roles/{roleId}
➔ Next to sshKey