fimidara — docs

`FimidaraEndpoints.permissionGroups.getWorkspacePermissionGroups`

Parameters

props—Optional

{

authToken: string

body?: GetWorkspacePermissionGroupsEndpointParams

}

GetWorkspacePermissionGroupsEndpointParams

—Optional

{

workspaceId?: string

page?: number

pageSize?: number

}

Result

—Optional

{

headers: Headers

body?: GetWorkspacePermissionGroupsEndpointResult

}

GetWorkspacePermissionGroupsEndpointResult

—Optional

{

permissionGroups: Array<PermissionGroup>

page: number

}

PermissionGroup

—Optional

{

resourceId: string

createdBy: Agent

createdAt: number

lastUpdatedBy: Agent

lastUpdatedAt: number

isDeleted: boolean

deletedAt?: number

deletedBy?: Agent

workspaceId: string

description?: string

}

Agent

—Optional

{

agentId: string

agentType: string

}

Throws

—Required

Error thrown, if error is an endpoint error.

{

errors: Array<FimidaraEndpointErrorItem>

statusCode: number

statusText?: string

headers: Headers

}

FimidaraEndpointErrorItem

—Optional

Server error item.

{

message: string

field?: string

}

`FimidaraEndpoints.permissionGroups.getWorkspacePermissionGroups`

Parameters

props—Optional

{

authToken: string

body?: GetWorkspacePermissionGroupsEndpointParams

}

GetWorkspacePermissionGroupsEndpointParams

—Optional

{

workspaceId?: string

page?: number

pageSize?: number

}

Result

—Optional

{

headers: Headers

body?: GetWorkspacePermissionGroupsEndpointResult

}

GetWorkspacePermissionGroupsEndpointResult

—Optional

{

permissionGroups: Array<PermissionGroup>

page: number

}

PermissionGroup

—Optional

{

resourceId: string

createdBy: Agent

createdAt: number

lastUpdatedBy: Agent

lastUpdatedAt: number

isDeleted: boolean

deletedAt?: number

deletedBy?: Agent

workspaceId: string

description?: string

}

Agent

—Optional

{

agentId: string

agentType: string

}

Throws

—Required

Error thrown, if error is an endpoint error.

{

errors: Array<FimidaraEndpointErrorItem>

statusCode: number

statusText?: string

headers: Headers

}

FimidaraEndpointErrorItem

—Optional

Server error item.

{

message: string

field?: string

}

FimidaraEndpoints.permissionGroups.getWorkspacePermissionGroups

Parameters

GetWorkspacePermissionGroupsEndpointParams

Result

GetWorkspacePermissionGroupsEndpointResult

PermissionGroup

Agent

Throws

FimidaraEndpointErrorItem

Loading...

FimidaraEndpoints.permissionGroups.getWorkspacePermissionGroups

Parameters

GetWorkspacePermissionGroupsEndpointParams

Result

GetWorkspacePermissionGroupsEndpointResult

PermissionGroup

Agent

Throws

FimidaraEndpointErrorItem

`FimidaraEndpoints.permissionGroups.getWorkspacePermissionGroups`

`FimidaraEndpoints.permissionGroups.getWorkspacePermissionGroups`