Skip to content
Equnix Metal
show

Users copied!

User Management

Retrieve current user invitations copied!

GET
/invitations

Returns all invitations in current user.

  • Parameters
  • include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Retrieve the custom metadata of a user copied!

GET
/users/{id}/customdata

Provides the custom metadata stored for this user in json format

Retrieve all users copied!

GET
/users

Returns a list of users that the are accessible to the current user (all users in the current user’s projects, essentially).

  • Parameters
  • include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create a user copied!

POST
/users

Creates a user.

  • Parameters
  • user
     (required) in body

    User to create

    first_name, last_name, emails

    {
        "first_name": "string",
        "last_name": "string",
        "phone_number": "string",
        "timezone": "string",
        "password": "string",
        "level": "string",
        "title": "string",
        "company_name": "string",
        "company_url": "string",
        "verified_at": "string",
        "social_accounts": "object",
        "two_factor_auth": "string",
        "avatar": "string",
        "emails": [
            {
                "address": "string",
                "default": "boolean"
            }
        ],
        "locked": "boolean",
        "customdata": "object"
    }

Retrieve a user copied!

GET
/users/{id}

Returns a single user if the user has access

  • Parameters
  • id
    string  (required) in path

    User UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Returns the user object for the currently logged-in user.

  • Parameters
  • include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Updates the currently logged-in user.

  • Parameters
  • user
     (required) in body

    User to update

    {
        "first_name": "string",
        "last_name": "string",
        "phone_number": "string",
        "timezone": "string",
        "password": "string",
        "avatar": "string",
        "customdata": "object"
    }