REST Resource: networks.roles

Resource: Role

The Role resource.

JSON representation
 { 
 "name" 
 : 
 string 
 , 
 "roleId" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "builtIn" 
 : 
 boolean 
 , 
 "status" 
 : 
 enum (  RoleStatus 
 
) 
 } 
Fields
name

string

Identifier. The resource name of the Role . Format: networks/{networkCode}/roles/{roleId}

roleId

string ( int64 format)

Output only. Role ID.

displayName

string

Required. The display name of the Role .

description

string

Optional. The description of the Role .

builtIn

boolean

Output only. Whether the Role is a built-in or custom user role.

status

enum ( RoleStatus )

Output only. The status of the Role .

RoleStatus

The status of the role.

Enums
ROLE_STATUS_UNSPECIFIED No value specified.
ACTIVE Role is active.
INACTIVE Role is inactive.

Methods

get

API to retrieve a Role object.

list

API to retrieve a list of Role objects.
Design a Mobile Site
View Site in Mobile | Classic
Share by: