Interface IRoleRead

Interface for reading roles.

Hierarchy

  • IRoleRead

Methods

getCustomRoles getOneByIdOrName

Methods

getCustomRoles

  • Retrieves all custom roles.

    Parameters

    • appId: string

      The id of the app.

    Returns Promise<IRole[]>

    All custom roles.

    Throws

    If there is an error while retrieving the roles.

    Throws

    If the app does not have the necessary permissions.

    See

    • IRole.protected
    • AppPermissions.role.read

getOneByIdOrName

  • Retrieves a role by its id or name.

    Parameters

    • idOrName: string

      The id or name of the role to retrieve.

    • appId: string

      The id of the app.

    Returns Promise<IRole>

    The role, if found.

    Throws

    If there is an error while retrieving the role.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc