Invite a user | Solvimon

curl -X POST https://test.api.solvimon.com/v1/users/invite \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "username": "johndoe@solvimon.com",
  "entity_id": "enti_123456789",
  "account_memberships": [
    {
      "account_id": "plat_123456789",
      "type": "USER",
      "role_ids": [
        "string"
      ],
      "roles": [
        {
          "name": "Administrator",
          "description": "string",
          "child_role_ids": [
            "string"
          ]
        },
        {
          "name": "Quote Viewer",
          "description": "string",
          "child_role_ids": [
            "string"
          ]
        }
      ]
    }
  ],
  "team_memberships": [
    {}
  ]
}'

{
  "username": "string",
  "entity_id": "string",
  "account_memberships": [
    {
      "account_id": "string",
      "type": "ADMIN",
      "role_ids": [
        "string"
      ],
      "object_type": "string",
      "id": "string",
      "account": {
        "id": "string",
        "reference": "string",
        "account_type_code": "string",
        "environment": "string",
        "account_group_id": "string",
        "parent_id": "string",
        "platform_id": "string"
      },
      "account_reference": "string",
      "environment": "string",
      "roles": [
        {
          "name": "string",
          "description": "string",
          "child_role_ids": [
            "string"
          ],
          "object_type": "string",
          "id": "string",
          "entity_id": "string",
          "child_roles": [
            {}
          ]
        }
      ]
    }
  ],
  "team_memberships": [
    {
      "team_id": "string",
      "start_at": "2024-01-15T09:30:00Z",
      "end_at": "2024-01-15T09:30:00Z",
      "account_memberships": [
        {
          "account_id": "string",
          "type": "ADMIN",
          "role_ids": [
            "string"
          ],
          "object_type": "string",
          "id": "string",
          "account": {
            "id": "string",
            "reference": "string",
            "account_type_code": "string",
            "environment": "string",
            "account_group_id": "string",
            "parent_id": "string",
            "platform_id": "string"
          },
          "account_reference": "string",
          "environment": "string",
          "roles": [
            {
              "name": "string",
              "description": "string",
              "child_role_ids": [
                "string"
              ],
              "object_type": "string",
              "id": "string",
              "entity_id": "string",
              "child_roles": [
                {}
              ]
            }
          ]
        }
      ]
    }
  ]
}

Requires the USER.MORTAL.CREATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Request

This endpoint expects an object.

usernamestringRequired

entity_idstringRequired

account_membershipslist of objectsRequired

team_membershipslist of objects or nullOptional

Response

usernamestring

entity_idstring

account_membershipslist of objects

team_membershipslist of objects or null

Errors

401

Unauthorized Error

403

Forbidden Error

Authentication

Path parameters

Headers

Request

Response

Errors