Type Alias InternalRole

type InternalRole = {
    createInternalRole(
        roleData: InternalRoleSkeleton,
    ): Promise<InternalRoleSkeleton>;
    createInternalRoleExportTemplate(): InternalRoleExportInterface;
    deleteInternalRole(roleId: string): Promise<InternalRoleSkeleton>;
    deleteInternalRoleByName(roleName: string): Promise<InternalRoleSkeleton>;
    deleteInternalRoles(): Promise<InternalRoleSkeleton[]>;
    exportInternalRole(roleId: string): Promise<InternalRoleExportInterface>;
    exportInternalRoleByName(
        roleName: string,
    ): Promise<InternalRoleExportInterface>;
    exportInternalRoles(): Promise<InternalRoleExportInterface>;
    importFirstInternalRole(
        importData: InternalRoleExportInterface,
    ): Promise<InternalRoleSkeleton[]>;
    importInternalRole(
        roleId: string,
        importData: InternalRoleExportInterface,
    ): Promise<InternalRoleSkeleton>;
    importInternalRoleByName(
        roleName: string,
        importData: InternalRoleExportInterface,
    ): Promise<InternalRoleSkeleton>;
    importInternalRoles(
        importData: InternalRoleExportInterface,
    ): Promise<InternalRoleSkeleton[]>;
    queryInternalRoles(
        filter: string,
        fields?: string[],
    ): Promise<InternalRoleSkeleton[]>;
    readInternalRole(roleId: string): Promise<InternalRoleSkeleton>;
    readInternalRoleByName(roleName: string): Promise<InternalRoleSkeleton>;
    readInternalRoles(): Promise<InternalRoleSkeleton[]>;
    updateInternalRole(
        roleId: string,
        roleData: InternalRoleSkeleton,
    ): Promise<InternalRoleSkeleton>;
}

Index

Methods

createInternalRole createInternalRoleExportTemplate deleteInternalRole deleteInternalRoleByName deleteInternalRoles exportInternalRole exportInternalRoleByName exportInternalRoles importFirstInternalRole importInternalRole importInternalRoleByName importInternalRoles queryInternalRoles readInternalRole readInternalRoleByName readInternalRoles updateInternalRole

Methods

createInternalRole

createInternalRole(
roleData: InternalRoleSkeleton,
): Promise<InternalRoleSkeleton>
Create internal role
Parameters
- roleData: InternalRoleSkeleton
  internal role data
Returns Promise<InternalRoleSkeleton>
a promise that resolves to an internal role object
- Defined in ops/InternalRoleOps.ts:42

createInternalRoleExportTemplate

createInternalRoleExportTemplate(): InternalRoleExportInterface
Create an empty internal role export template

Returns InternalRoleExportInterface
an empty internal role export template
- Defined in ops/InternalRoleOps.ts:36

deleteInternalRole

deleteInternalRole(roleId: string): Promise<InternalRoleSkeleton>
Delete internal role
Parameters
- roleId: string
  internal role uuid
Returns Promise<InternalRoleSkeleton>
a promise that resolves to an internal role object
- Defined in ops/InternalRoleOps.ts:77

deleteInternalRoleByName

deleteInternalRoleByName(roleName: string): Promise<InternalRoleSkeleton>
Delete internal role by name
Parameters
- roleName: string
  internal role name
Returns Promise<InternalRoleSkeleton>
a promise that resolves to an internal role object
- Defined in ops/InternalRoleOps.ts:83

deleteInternalRoles

deleteInternalRoles(): Promise<InternalRoleSkeleton[]>
Delete all internal roles

Returns Promise<InternalRoleSkeleton[]>
a promise that resolves to an array of internal role objects
- Defined in ops/InternalRoleOps.ts:88

exportInternalRole

exportInternalRole(roleId: string): Promise<InternalRoleExportInterface>
Export internal role. The response can be saved to file as is.
Parameters
- roleId: string
  internal role uuid
Returns Promise<InternalRoleExportInterface>
Promise resolving to an InternalRoleExportInterface object.
- Defined in ops/InternalRoleOps.ts:103

exportInternalRoleByName

exportInternalRoleByName(roleName: string): Promise<InternalRoleExportInterface>
Export internal role by name. The response can be saved to file as is.
Parameters
- roleName: string
  internal role name
Returns Promise<InternalRoleExportInterface>
Promise resolving to an InternalRoleExportInterface object.
- Defined in ops/InternalRoleOps.ts:109

exportInternalRoles

exportInternalRoles(): Promise<InternalRoleExportInterface>
Export all internal roles. The response can be saved to file as is.

Returns Promise<InternalRoleExportInterface>
Promise resolving to an InternalRoleExportInterface object.
- Defined in ops/InternalRoleOps.ts:116

importFirstInternalRole

importFirstInternalRole(
importData: InternalRoleExportInterface,
): Promise<InternalRoleSkeleton[]>
Import first internal role. The import data is usually read from an internal role export file.
Parameters
- importData: InternalRoleExportInterface
  internal role import data.
Returns Promise<InternalRoleSkeleton[]>
- Defined in ops/InternalRoleOps.ts:141

importInternalRole

importInternalRole(
roleId: string,
importData: InternalRoleExportInterface,
): Promise<InternalRoleSkeleton>
Import internal role. The import data is usually read from an internal role export file.
Parameters
- roleId: string
  internal role uuid
- importData: InternalRoleExportInterface
  internal role import data.
Returns Promise<InternalRoleSkeleton>
Promise resolving to an internal role object.
- Defined in ops/InternalRoleOps.ts:123

importInternalRoleByName

importInternalRoleByName(
roleName: string,
importData: InternalRoleExportInterface,
): Promise<InternalRoleSkeleton>
Import internal role by name. The import data is usually read from an internal role export file.
Parameters
- roleName: string
  internal role name
- importData: InternalRoleExportInterface
  internal role import data.
Returns Promise<InternalRoleSkeleton>
Promise resolving to an internal role object.
- Defined in ops/InternalRoleOps.ts:133

importInternalRoles

importInternalRoles(
importData: InternalRoleExportInterface,
): Promise<InternalRoleSkeleton[]>
Import internal roles. The import data is usually read from an internal role export file.
Parameters
- importData: InternalRoleExportInterface
  internal role import data.
Returns Promise<InternalRoleSkeleton[]>
- Defined in ops/InternalRoleOps.ts:148

queryInternalRoles

queryInternalRoles(
filter: string,
fields?: string[],
): Promise<InternalRoleSkeleton[]>
Query internal roles
Parameters
- filter: string
  CREST search filter
- Optionalfields: string[]
  array of fields to return
Returns Promise<InternalRoleSkeleton[]>
- Defined in ops/InternalRoleOps.ts:94

readInternalRole

readInternalRole(roleId: string): Promise<InternalRoleSkeleton>
Read internal role
Parameters
- roleId: string
  internal role uuid
Returns Promise<InternalRoleSkeleton>
a promise that resolves to an internal role object
- Defined in ops/InternalRoleOps.ts:50

readInternalRoleByName

readInternalRoleByName(roleName: string): Promise<InternalRoleSkeleton>
Read internal role by name
Parameters
- roleName: string
  internal role name
Returns Promise<InternalRoleSkeleton>
a promise that resolves to an internal role object
- Defined in ops/InternalRoleOps.ts:56

readInternalRoles

readInternalRoles(): Promise<InternalRoleSkeleton[]>
Read all internal roles. Results are sorted aphabetically.

Returns Promise<InternalRoleSkeleton[]>
a promise that resolves to an array of internal role objects
- Defined in ops/InternalRoleOps.ts:61

updateInternalRole

updateInternalRole(
roleId: string,
roleData: InternalRoleSkeleton,
): Promise<InternalRoleSkeleton>
Update internal role
Parameters
- roleId: string
  internal role uuid
- roleData: InternalRoleSkeleton
  internal role data
Returns Promise<InternalRoleSkeleton>
a promise that resolves to an internal role object
- Defined in ops/InternalRoleOps.ts:68

Type Alias InternalRole

Index

Methods

Methods

createInternalRole

Parameters

Returns Promise<InternalRoleSkeleton>

createInternalRoleExportTemplate

Returns InternalRoleExportInterface

deleteInternalRole

Parameters

Returns Promise<InternalRoleSkeleton>

deleteInternalRoleByName

Parameters

Returns Promise<InternalRoleSkeleton>

deleteInternalRoles

Returns Promise<InternalRoleSkeleton[]>

exportInternalRole

Parameters

Returns Promise<InternalRoleExportInterface>

exportInternalRoleByName

Parameters

Returns Promise<InternalRoleExportInterface>

exportInternalRoles

Returns Promise<InternalRoleExportInterface>

importFirstInternalRole

Parameters

Returns Promise<InternalRoleSkeleton[]>

importInternalRole

Parameters

Returns Promise<InternalRoleSkeleton>

importInternalRoleByName

Parameters

Returns Promise<InternalRoleSkeleton>

importInternalRoles

Parameters

Returns Promise<InternalRoleSkeleton[]>

queryInternalRoles

Parameters

Returns Promise<InternalRoleSkeleton[]>

readInternalRole

Parameters

Returns Promise<InternalRoleSkeleton>

readInternalRoleByName

Parameters

Returns Promise<InternalRoleSkeleton>

readInternalRoles

Returns Promise<InternalRoleSkeleton[]>

updateInternalRole

Parameters

Returns Promise<InternalRoleSkeleton>

Settings

On This Page