Member | SumUp Developer

A member is user within specific resource identified by resource id, resource type, and associated roles.

Fields

idstringrequired
ID of the member.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
rolesarray<string>required
User's roles.

Example: ["role_admin"]
permissionsarray<string>requireddeprecated
User's permissions.

Example: ["members_read","members_write","create_moto_payments","full_transaction_history_view","refund_transactions","create_referral","developer_settings_edit","developer_settings_access"]
created_atstringrequired
format: date-time
The timestamp of when the member was created.

Example: "2023-01-20T15:16:17Z"
updated_atstringrequired
format: date-time
The timestamp of when the member was last updated.

Example: "2023-01-20T15:16:17Z"
statusstringrequired
Options:"accepted""pending""expired""disabled""unknown"
The status of the membership.
userobject
Information about the user associated with the membership.
Show 10 properties
- idstringrequired
  Identifier for the End-User (also called Subject).
  
  Example: "44ca0f5b-813b-46e1-aee7-e6242010662e"
- typestringrequired
  Options:"user""managed_user""service_account""system_account"
  Type of the user account.
  
  Example: "user"
- emailstringrequired
  End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, for unique identification use ID instead.
  
  Example: "example@sumup.com"
- mfa_on_login_enabledbooleanrequired
  True if the user has enabled MFA on login.
  
  Example: true
- virtual_userbooleanrequireddeprecated
  True if the user is a virtual user (operator).
  
  Example: false
- service_account_userbooleanrequireddeprecated
  True if the user is a service account.
  
  Example: false
- disabled_atstring
  format: date-time
  Time when the user has been disabled. Applies only to virtual users (virtual_user: true).
- nicknamestring
  User's nickname. Used for display purposes only.
  
  Example: "Test User"
- picturestring
  format: uri
  URL of the End-User's profile picture. This URL refers to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image.
  
  Example: "https://usercontent.sumup.com/44ca0f5b-813b-46e1-aee7-e6242010662e.png"
- classicobjectdeprecated
  Classic identifiers of the user.
  
  Show 1 property
  user_idintegerrequired
  minimum: 0maximum: 2147483647
inviteobject
Pending invitation for membership.
Show 2 properties
- emailstringrequired
  format: email
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
- expires_atstringrequired
  format: date-time
  Example: "2023-01-20T15:16:17Z"
metadataobject
Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. Maximum of 64 parameters are allowed in the object.

Example: {}
attributesobject
Object attributes that are modifiable only by SumUp applications.

Example: {}