Type alias InternalRole

Type declaration

• createInternalRole:function

  • 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

• createInternalRoleExportTemplate:function

  • createInternalRoleExportTemplate(): InternalRoleExportInterface

  • Create an empty internal role export template

    Returns InternalRoleExportInterface

    an empty internal role export template

• deleteInternalRole:function

  • 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

• deleteInternalRoleByName:function

  • 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

• deleteInternalRoles:function

  • deleteInternalRoles(): Promise<InternalRoleSkeleton[]>

  • Delete all internal roles

    Returns Promise<InternalRoleSkeleton[]>

    a promise that resolves to an array of internal role objects

• exportInternalRole:function

  • 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.

• exportInternalRoleByName:function

  • 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.

• exportInternalRoles:function

  • 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.

• importFirstInternalRole:function

  • 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[]>

• importInternalRole:function

  • 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.

• importInternalRoleByName:function

  • 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.

• importInternalRoles:function

  • 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[]>

• queryInternalRoles:function

  • queryInternalRoles(filter: string, fields?: string[]): Promise<InternalRoleSkeleton[]>

  • Query internal roles

    Parameters

    • filter: string

      CREST search filter
    • Optional fields: string[]

      array of fields to return

    Returns Promise<InternalRoleSkeleton[]>

• readInternalRole:function

  • 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

• readInternalRoleByName:function

  • 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

• readInternalRoles:function

  • 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

• updateInternalRole:function

  • 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