---
title: "Invite a new user"
slug: "invite-a-new-user"
updated: 2024-11-05T13:31:41Z
published: 2024-11-05T13:31:41Z
canonical: "developers.torq.io/invite-a-new-user"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developers.torq.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Invite a new user

Post/v1alpha/users/invite

Invites a new user into the workspace.

SecurityHTTPType bearer

Body parameters

Invite a new user model

<select class='api-response-data' aria-label='Media type'><option value='bb9da2e4-7766-4997-b86c-9522603c4764'>application/json</option>
</select>object 

Invite a new user model

emailstring  (email)    Required

The email address of the user to invite.

Exampleuser@email.com
role_idstring  (uuid)    

The ID of the role to assign to the invited user. If no role ID is provided, the Viewer role is assigned. To get a list of role IDs, make a `List roles` request.

The default role is viewer.

Example74e19393-3e94-48d2-8b60-26f2d2665942

Responses200

A successful response.

<select class='api-response-data' aria-label='Media type'><option value='0237d72e-5dfb-4b82-8397-13d6db731063'>application/json</option>
</select>object 

The user object

idstring  (uuid)    

The unique identifier of the user.

Example74e19393-3e94-48d2-8b60-26f2d2665942
emailstring  (email)    

The email address of the user.

Exampleuser@email.com
role_idstring  (uuid)    

The unique identifier of the role assigned to the user.

Example74e19393-3e94-48d2-8b60-26f2d2665942
statusstring    

- STATUS_UNSPECIFIED: Default value. This value is unused.
- INVITATION_SENT: Invitation email has been sent.
- VERIFIED: Membership verified.

Valid values[
  "STATUS_UNSPECIFIED",
  "INVITATION_SENT",
  "VERIFIED"
]Default"STATUS_UNSPECIFIED"
sso_provisionboolean    

If `true`, the user was provisioned in Torq with the SSO IdP.

ExampleTrue
created_timestring  (date-time)    

The timestamp when the user was created.

Example2022-03-09T08:40:18Z
last_login_timestring  (date-time)    

The timestamp when the user last logged in to Torq via the UI or the API.

Example2022-03-09T08:40:18Z

201

User was invited successfully

<select class='api-response-data' aria-label='Media type'><option value='e1065e2f-8d59-46c5-8e8f-3ff3b34beb8b'>application/json</option>
</select>object 

401

Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.

<select class='api-response-data' aria-label='Media type'><option value='8c1872a3-8ceb-464b-8d6f-1145359f3ad2'>application/json</option>
</select>object 

403

You don't have permission to access this resource.

<select class='api-response-data' aria-label='Media type'><option value='5f948b82-9085-460b-9670-26e6f4b07b57'>application/json</option>
</select>object 

default

An unexpected error response.

<select class='api-response-data' aria-label='Media type'><option value='be4a8d5f-2586-4ce8-828f-ce93074e5095'>application/json</option>
</select>Expand Allobject codeinteger  (int32)    
messagestring    
details Array of object (protobufAny)   object 

`Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo))

Example 2: Pack and unpack a message in Java.

Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) // or ... if (any.isSameTypeAs(Foo.getDefaultInstance()))

Example 3: Pack and unpack a message in Python.

foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo any, err := anypb.New(foo) if err != nil ... foo := &pb.Foo if err := any.UnmarshalTo(foo); err != nil

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

# JSON

The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

package google.profile; message Person

{ "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, &quot;lastName&quot;: <string> }</string></string>

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

@typestring    

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

- If no scheme is provided, `https` is assumed.
- An HTTP GET on the URL must yield a [google.protobuf.Type][]
value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the
URL, or have them precompiled into a binary to avoid any
lookup. Therefore, binary compatibility needs to be preserved
on changes to types. (Use versioned type names to manage
breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

property*object additionalProperties