local universe

System Members

System members represent users that have joined a system. Each member has system-specific properties like a nickname, avatar, assigned roles, and permission flags.

The system member model

Properties

  • Name
    system_id
    Type
    string
    Description

    The ID of the system this member belongs to.

  • Name
    user_id
    Type
    string
    Description

    The ID of the user.

  • Name
    user
    Type
    User?
    Description

    The resolved user object, when included.

  • Name
    nick
    Type
    string?
    Description

    The member's system-specific nickname.

  • Name
    avatar
    Type
    string?
    Description

    The member's system-specific avatar URL.

  • Name
    roles
    Type
    string[]
    Description

    Array of role IDs assigned to this member.

  • Name
    joined_at
    Type
    timestamp
    Description

    When the member joined the system.

  • Name
    premium_since
    Type
    timestamp?
    Description

    When the member started boosting the system.

  • Name
    deaf
    Type
    boolean
    Description

    Whether the member is deafened in voice channels.

  • Name
    mute
    Type
    boolean
    Description

    Whether the member is muted in voice channels.

  • Name
    pending
    Type
    boolean
    Description

    Whether the member has passed the membership screening.

  • Name
    communication_disabled_until
    Type
    timestamp?
    Description

    When the member's timeout expires, if timed out.

  • Name
    flags
    Type
    integer
    Description

    Member flags bitfield. See member flags below.

Member flags

ValueNameDescription
1DID_REJOINMember has rejoined the system
2COMPLETED_ONBOARDINGMember has completed onboarding
4BYPASSES_VERIFICATIONMember bypasses verification requirements
8STARTED_ONBOARDINGMember has started onboarding
GET/v1/systems/:systemId/members

List members

Returns all members of a system.

Request

GET
/v1/systems/1344387816333352652/members
curl https://api.localuniverse.io/v1/systems/1344387816333352652/members \
  -H "Authorization: Bearer {token}"
PUT/v1/systems/:systemId/members/@me

Join a system

Add the authenticated user as a member of the system.

Request

PUT
/v1/systems/1344387816333352652/members/@me
curl -X PUT https://api.localuniverse.io/v1/systems/1344387816333352652/members/@me \
  -H "Authorization: Bearer {token}"
GET/v1/systems/:systemId/members/:userId

Get a member

Retrieve a specific member by user ID.

Request

GET
/v1/systems/1344387816333352652/members/1344387816333399999
curl https://api.localuniverse.io/v1/systems/1344387816333352652/members/1344387816333399999 \
  -H "Authorization: Bearer {token}"
PATCH/v1/systems/:systemId/members/:userId

Update a member

Optional attributes

  • Name
    nick
    Type
    string
    Description

    New nickname for the member.

  • Name
    roles
    Type
    string[]
    Description

    Array of role IDs to assign.

  • Name
    mute
    Type
    boolean
    Description

    Whether the member is muted.

  • Name
    deaf
    Type
    boolean
    Description

    Whether the member is deafened.

  • Name
    communication_disabled_until
    Type
    string
    Description

    ISO timestamp for timeout expiry, or null to remove.

Request

PATCH
/v1/systems/1344387816333352652/members/1344387816333399999
curl -X PATCH https://api.localuniverse.io/v1/systems/1344387816333352652/members/1344387816333399999 \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"nick": "Cool Nickname"}'
DELETE/v1/systems/:systemId/members/:userId

Remove a member

Remove a member from the system (kick). Use @me to leave the system.

Request

DELETE
/v1/systems/1344387816333352652/members/1344387816333399999
curl -X DELETE https://api.localuniverse.io/v1/systems/1344387816333352652/members/1344387816333399999 \
  -H "Authorization: Bearer {token}"
PUT/v1/systems/:systemId/members/:userId/roles/:roleId

Add member role

Assign a role to a member.

Request

PUT
/v1/systems/.../members/.../roles/...
curl -X PUT https://api.localuniverse.io/v1/systems/1344387816333352652/members/1344387816333399999/roles/1344387816333355555 \
  -H "Authorization: Bearer {token}"
DELETE/v1/systems/:systemId/members/:userId/roles/:roleId

Remove member role

Remove a role from a member.

Request

DELETE
/v1/systems/.../members/.../roles/...
curl -X DELETE https://api.localuniverse.io/v1/systems/1344387816333352652/members/1344387816333399999/roles/1344387816333355555 \
  -H "Authorization: Bearer {token}"
GET/v1/systems/:systemId/members/:userId/permissions

Get member permissions

Returns the computed permissions for a member in the system.

Request

GET
/v1/systems/.../members/.../permissions
curl https://api.localuniverse.io/v1/systems/1344387816333352652/members/1344387816333399999/permissions \
  -H "Authorization: Bearer {token}"

Was this page helpful?