Class Privileges

constructor

• new Privileges(api: Api): Privileges

  Parameters

  • api: Api

  Returns Privileges

api

addSecurityGroupUsers

• addSecurityGroupUsers(
      groupId: string,
      users: { id: string }[],
  ): Promise<ApiResponse<void, void>>

  Parameters

  • groupId: string
  • users: { id: string }[]

  Returns Promise<ApiResponse<void, void>>

cloneSecurityGroup

• cloneSecurityGroup(
      groupId: string,
      data: CreateSecurityGroupRequest,
      scope?: "all" | "users" | "privileges",
  ): Promise<ApiResponse<SecurityGroup, SecurityGroup>>

  Parameters

  • groupId: string
  • data: CreateSecurityGroupRequest
  • scope: "all" | "users" | "privileges" = 'all'

  Returns Promise<ApiResponse<SecurityGroup, SecurityGroup>>

createSecurityGroup

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

  Parameters

  • data: CreateSecurityGroupRequest

  Returns Promise<ApiResponse<SecurityGroup, SecurityGroup>>

createTypePrivileges

• createTypePrivileges(
      groupId: string,
      type: string,
      privileges: Privilege[],
  ): Promise<ApiResponse<TypePrivilege, TypePrivilege>>

  Parameters

  • groupId: string
  • type: string
  • privileges: Privilege[]

  Returns Promise<ApiResponse<TypePrivilege, TypePrivilege>>

deleteSecurityGroup

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

  Parameters

  • groupId: string

  Returns Promise<ApiResponse<void, void>>

deleteSecurityGroupUser

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

  Parameters

  • groupId: string
  • userId: string

  Returns Promise<ApiResponse<void, void>>

getAttributePrivileges

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

  Parameters

  • groupId: string
  • type: string
  • page: number = 1
  • perPage: number = 100

  Returns Promise<ApiResponse<AttributePrivilegesResponse, AttributePrivilegesResponse>>

getSecurityGroups

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

  Parameters

  • organization: string
  • page: number = 1
  • perPage: number = 100

  Returns Promise<ApiResponse<SecurityGroupsResponse, SecurityGroupsResponse>>

getSecurityGroupsUsersBatch

• getSecurityGroupsUsersBatch(
      groupIds: string[],
  ): Promise<
      ApiResponse<
          {
              securityGroups: Record<string, UserWithOrganizations[]>;
              totalUsers: number;
          },
          {
              securityGroups: Record<string, UserWithOrganizations[]>;
              totalUsers: number;
          },
      >,
  >

  Parameters

  • groupIds: string[]

  Returns Promise<
      ApiResponse<
          {
              securityGroups: Record<string, UserWithOrganizations[]>;
              totalUsers: number;
          },
          {
              securityGroups: Record<string, UserWithOrganizations[]>;
              totalUsers: number;
          },
      >,
  >

getSecurityGroupUsers

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

  Parameters

  • groupId: string
  • page: number = 1
  • perPage: number = 100

  Returns Promise<ApiResponse<UsersResponse, UsersResponse>>

getTypePrivileges

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

  Parameters

  • groupId: string
  • type: string
  • page: number = 1
  • perPage: number = 1

  Returns Promise<ApiResponse<TypePrivilegesResponse, TypePrivilegesResponse>>

getUserSecurityGroups

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

  Parameters

  • organization: string

  Returns Promise<ApiResponse<SecurityGroupsResponse, SecurityGroupsResponse>>

setAttributePrivileges

• setAttributePrivileges(
      groupId: string,
      privileges: AttributePrivilege[],
  ): Promise<ApiResponse<void, void>>

  Parameters

  • groupId: string
  • privileges: AttributePrivilege[]

  Returns Promise<ApiResponse<void, void>>

updateTypePrivileges

• updateTypePrivileges(
      groupId: string,
      privilegeId: string,
      privileges: Privilege[],
  ): Promise<ApiResponse<void, void>>

  Parameters

  • groupId: string
  • privilegeId: string
  • privileges: Privilege[]

  Returns Promise<ApiResponse<void, void>>