Class Privileges

constructor

• new Privileges(api): Privileges

• Parameters

  • api: Api

  Returns Privileges

api

addSecurityGroupUsers

• addSecurityGroupUsers(groupId, users): Promise<ApiResponse<void, void>>

• Parameters

  • groupId: string

  • users: {
        id: string;
    }[]

  Returns Promise<ApiResponse<void, void>>

cloneSecurityGroup

• cloneSecurityGroup(groupId, data, scope?): Promise<ApiResponse<SecurityGroup, SecurityGroup>>

• Parameters

  • groupId: string

  • data: CreateSecurityGroupRequest

  • scope: "all" | "users" | "privileges" = 'all'

  Returns Promise<ApiResponse<SecurityGroup, SecurityGroup>>

createSecurityGroup

• createSecurityGroup(data): Promise<ApiResponse<SecurityGroup, SecurityGroup>>

• Parameters

  • data: CreateSecurityGroupRequest

  Returns Promise<ApiResponse<SecurityGroup, SecurityGroup>>

createTypePrivileges

• createTypePrivileges(groupId, type, privileges): Promise<ApiResponse<TypePrivilege, TypePrivilege>>

• Parameters

  • groupId: string

  • type: string

  • privileges: Privilege[]

  Returns Promise<ApiResponse<TypePrivilege, TypePrivilege>>

deleteSecurityGroup

• deleteSecurityGroup(groupId): Promise<ApiResponse<void, void>>

• Parameters

  • groupId: string

  Returns Promise<ApiResponse<void, void>>

deleteSecurityGroupUser

• deleteSecurityGroupUser(groupId, userId): Promise<ApiResponse<void, void>>

• Parameters

  • groupId: string

  • userId: string

  Returns Promise<ApiResponse<void, void>>

getAttributePrivileges

• getAttributePrivileges(groupId, type, page?, perPage?): Promise<ApiResponse<AttributePrivilegesResponse, AttributePrivilegesResponse>>

• Parameters

  • groupId: string

  • type: string

  • page: number = 1

  • perPage: number = 100

  Returns Promise<ApiResponse<AttributePrivilegesResponse, AttributePrivilegesResponse>>

getSecurityGroupUsers

• getSecurityGroupUsers(groupId, page?, perPage?): Promise<ApiResponse<UsersResponse, UsersResponse>>

• Parameters

  • groupId: string

  • page: number = 1

  • perPage: number = 100

  Returns Promise<ApiResponse<UsersResponse, UsersResponse>>

getSecurityGroups

• getSecurityGroups(organization, page?, perPage?): Promise<ApiResponse<SecurityGroupsResponse, SecurityGroupsResponse>>

• Parameters

  • organization: string

  • page: number = 1

  • perPage: number = 100

  Returns Promise<ApiResponse<SecurityGroupsResponse, SecurityGroupsResponse>>

getTypePrivileges

• getTypePrivileges(groupId, type, page?, perPage?): Promise<ApiResponse<TypePrivilegesResponse, TypePrivilegesResponse>>

• Parameters

  • groupId: string

  • type: string

  • page: number = 1

  • perPage: number = 1

  Returns Promise<ApiResponse<TypePrivilegesResponse, TypePrivilegesResponse>>

getUserSecurityGroups

• getUserSecurityGroups(organization): Promise<ApiResponse<SecurityGroupsResponse, SecurityGroupsResponse>>

• Parameters

  • organization: string

  Returns Promise<ApiResponse<SecurityGroupsResponse, SecurityGroupsResponse>>

setAttributePrivileges

• setAttributePrivileges(groupId, privileges): Promise<ApiResponse<void, void>>

• Parameters

  • groupId: string

  • privileges: AttributePrivilege[]

  Returns Promise<ApiResponse<void, void>>

updateTypePrivileges

• updateTypePrivileges(groupId, privilegeId, privileges): Promise<ApiResponse<void, void>>

• Parameters

  • groupId: string

  • privilegeId: string

  • privileges: Privilege[]

  Returns Promise<ApiResponse<void, void>>