Authenticate a workspace user by user name or email.

POST

/api/workspace/auth/login

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/auth/login"),
    Content = new StringContent("{ \"UserNameOrEmail\": \"example\", \"Password\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/auth/login';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"UserNameOrEmail":"example","Password":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/auth/login \
  --header 'Content-Type: application/json' \
  --data '{ "UserNameOrEmail": "example", "Password": "example" }'

Locale is resolved from the workspace settings.

Request Body

Request payload to authenticate a workspace user.

object

UserNameOrEmail

Workspace user name or email address.

string

nullable

Password

Account password.

string

nullable

Example^generated

{
  "UserNameOrEmail": "example",
  "Password": "example"
}

Request payload to authenticate a workspace user.

object

UserNameOrEmail

Workspace user name or email address.

string

nullable

Password

Account password.

string

nullable

Example^generated

{
  "UserNameOrEmail": "example",
  "Password": "example"
}

Request payload to authenticate a workspace user.

object

UserNameOrEmail

Workspace user name or email address.

string

nullable

Password

Account password.

string

nullable

Example^generated

{
  "UserNameOrEmail": "example",
  "Password": "example"
}

Responses

200

application/json

object

Data

Workspace authentication response with access token and user profile.

object

AccessToken

required

Access token for the workspace session.

string

nullable

UserId

required

Workspace user identifier.

string

nullable

UserName

required

User login name.

string

nullable

Email

User email address.

string

nullable

FirstName

User first name.

string

nullable

LastName

User last name.

string

nullable

UserType

required

integer format: int32

Allowed values: 0 1 2

WorkspaceName

required

Workspace slug identifier.

string

nullable

Locale

required

Workspace locale code.

string

nullable

TimeZone

required

Workspace time zone identifier.

string

nullable

DateTimeFormat

required

Workspace date-time format pattern.

string

nullable

DateFormat

required

Workspace date format pattern.

string

nullable

TimeFormat

required

Workspace time format pattern.

string

nullable

RegionCode

Workspace routing region code.

string

nullable

OnboardingStatus

required

integer format: int32

Allowed values: 0 1 2

Roles

required

Role names assigned to the user.

Array<string>

nullable

Permissions

required

Permission keys assigned to the user.

Array<string>

nullable

Modules

required

Typed module availability snapshot included in the authenticated user context.

object

Boards

Availability state for one workspace module in the authenticated user context.

object

Enabled

boolean

Booking

Availability state for one workspace module in the authenticated user context.

object

Enabled

boolean

CurrencyRates

Availability state for one workspace module in the authenticated user context.

object

Enabled

boolean

EntitlementOperations

Availability state for one workspace module in the authenticated user context.

object

Enabled

boolean

WorkInbox

Availability state for one workspace module in the authenticated user context.

object

Enabled

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "UserType": 0,
    "OnboardingStatus": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Workspace authentication response with access token and user profile.

object

AccessToken

required

Access token for the workspace session.

string

nullable

UserId

required

Workspace user identifier.

string

nullable

UserName

required

User login name.

string

nullable

Email

User email address.

string

nullable

FirstName

User first name.

string

nullable

LastName

User last name.

string

nullable

UserType

required

integer format: int32

Allowed values: 0 1 2

WorkspaceName

required

Workspace slug identifier.

string

nullable

Locale

required

Workspace locale code.

string

nullable

TimeZone

required

Workspace time zone identifier.

string

nullable

DateTimeFormat

required

Workspace date-time format pattern.

string

nullable

DateFormat

required

Workspace date format pattern.

string

nullable

TimeFormat

required

Workspace time format pattern.

string

nullable

RegionCode

Workspace routing region code.

string

nullable

OnboardingStatus

required

integer format: int32

Allowed values: 0 1 2

Roles

required

Role names assigned to the user.

Array<string>

nullable

Permissions

required

Permission keys assigned to the user.

Array<string>

nullable

Modules

required

Typed module availability snapshot included in the authenticated user context.

object

Boards

Availability state for one workspace module in the authenticated user context.

object

Enabled

boolean

Booking

Availability state for one workspace module in the authenticated user context.

object

Enabled

boolean

CurrencyRates

Availability state for one workspace module in the authenticated user context.

object

Enabled

boolean

EntitlementOperations

Availability state for one workspace module in the authenticated user context.

object

Enabled

boolean

WorkInbox

Availability state for one workspace module in the authenticated user context.

object

Enabled

boolean

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "UserType": 0,
    "OnboardingStatus": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Authenticate a workspace user by user name or email.

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

Example^generated

Example^generated

Example^generated