Add Role

This API enables you to add a role to vCenter Chargeback Manager.

User Privileges Required

You must have the Super User role or the Administrator role.

Syntax

The syntax for calling this method is:

POST <Base_Url>/role

A sample API call is as follows:

POST https://123.123.123.123/vCenter-CB/api/role

Request Body Parameters

The request XML for this API includes the following body parameters.

XPath

Type

Min Occurs

Max Occurs

Description

Roles/Role

 

1

1

This is the Role element

Roles/Role/Name

xs:string

1

1

Name of the user role. For example, Report Manager.

Roles/Role/Description

xs:string

0

1

An optional description for the user role. The character limit for the description is 512 characters.

Roles/Role/Privileges/Privilege

 

 

 

Represents the Privileges element for a role.

Roles/Role/Privileges/Privilege/@id

xs:int

1

unbounded

The unique ID of the privilege the user role is assigned. For example, 21.

A sample request XML is provided here.

API Response

If the operation is successful, the API gets an XML response with the following details.

XPath

Type

Min Occurs

Max Occurs

Description

Roles/Role

 

1

1

This is the Role element

Roles/Role/@id

xs:int

1

1

ID of the role.

Roles/Role/Name

xs:string

1

1

Name for the user role.

Roles/Role/Description

xs:string

1

1

An optional description for the user role.

Roles/Role/Custom

xs:boolean

 

 

Indicates whether the new role is a custom role.

Roles/Role/Privileges/Privilege

 

1

unbounded

This is the Privilege element

Roles/Role/Privileges/Privilege/@id

xs:int

1

1

The unique ID of the privilege the user role is assigned.

Privileges/Privilege

 

 

 

Represents the Privileges element.

Privileges/Privilege/@id

xs:int

1

1

ID of the privilege.

Privileges/Privilege/Name

xs:string

1

1

Name of the privilege.

Privileges/Privilege/Description

xs:string

1

1

Description of the privilege.

Privileges/Privilege/ResourceType/@id

xs:int

1

1

ID of the resource type

A sample response is provided here.

Error Codes

The following table explains the error codes displayed by the API.

Error code

Description

VCENTER_COMMON_ERR_INSUFFICIENT_PERMISSION

User does not have the required permissions to perform this operation.

VCENTER_COMMON_ERR_USER_NOT_AUTHENTICATED

User is not authenticated to perform this operation.

VCB_ERR_INVALID_ROLE_ID

The specified role ID is not a valid ID.

VCB_ERR_INVALID_ROLE_NAME

Role name is longer than 255 characters or invalid.

VCB_ERR_INVALID_ROLE_DESCRIPTION

Description is longer than 512 characters.

VCB_ERR_ROLE_NAME_EXISTS

A role with the same name exists

VCB_ERR_INVALID_PRIVILEGE_ID

No privilege exists with the given privilege ID.

VCB_ERR_PRIVILEGES_MISSING

Cannot create a role without privileges.