@sumup/sdk
    Preparing search index...

    Type Alias CreateMerchantMemberParams

    type CreateMerchantMemberParams = {
        attributes?: SumUp.Members.Attributes;
        email: string;
        is_managed_user?: boolean;
        is_service_account?: boolean;
        metadata?: SumUp.Members.Metadata;
        nickname?: string;
        password?: string;
        roles: string[];
    }
    Index

    Properties

    attributes?: SumUp.Members.Attributes
    email: string

    Email address of the member to add.

    is_managed_user?: boolean

    True if the user is managed by the merchant. In this case, we'll created a virtual user with the provided password and nickname.

    is_service_account?: boolean

    True if the user is a service account. It can later be used to create OAuth2 clients.

    nickname?: string

    Nickname of the member to add. Only used if is_managed_user is true. Used for display purposes only.

    password?: string

    Password of the member to add. Only used if is_managed_user is true. In the case of service accounts, the password is not used and can not be defined by the caller.

    roles: string[]

    List of roles to assign to the new member. In the case of service accounts, the roles are predefined.