@sumup/sdk
    Preparing search index...

    Type Alias Role

    Role

    A custom role that can be used to assign set of permissions to members.

    type Role = {
        created_at: string;
        description?: string;
        id: string;
        is_predefined: boolean;
        metadata?: SumUp.Roles.Metadata;
        name: string;
        permissions: string[];
        updated_at: string;
    }
    Index

    Properties

    created_at description? id is_predefined metadata? name permissions updated_at

    Properties

    created_at: string

    The timestamp of when the role was created.

    description?: string

    User-defined description of the role.

    id: string

    Unique identifier of the role.

    is_predefined: boolean

    True if the role is provided by SumUp.

    metadata?: SumUp.Roles.Metadata
    name: string

    User-defined name of the role.

    permissions: string[]

    List of permission granted by this role.

    updated_at: string

    The timestamp of when the role was last updated.

    Settings

    Member Visibility

    On This Page

    Properties