Documentation Powered by ReDoc

Altair SLC Hub Authentication and Identity (2024.0.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Returns the user entity corresponding to the requesting user

Authorizations:
bearerAuth
query Parameters
fields
Array of strings (userField)
Items Enum: "_id" "_created" "_modified" "externalId" "userName" "displayName" "active" "email" "unixHomeDirectory" "unixUserName" "userPrincipalName" "invitationPending" "deleted"
excludeFields
Array of strings (userField)
Items Enum: "_id" "_created" "_modified" "externalId" "userName" "displayName" "active" "email" "unixHomeDirectory" "unixUserName" "userPrincipalName" "invitationPending" "deleted"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "system": true,
  • "userName": "string",
  • "displayName": "string",
  • "active": true,
  • "email": "string",
  • "unixHomeDirectory": "string",
  • "unixUserName": "string",
  • "userPrincipalName": "string",
  • "invitationPending": true,
  • "invitationExpiry": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Queries current user instances

Authorizations:
bearerAuth
query Parameters
filter[_id][EQ]
string
filter[_id][IN]
Array of strings
filter[userName][EQ]
string
filter[userName][CO]
string
filter[displayName][EQ]
string
filter[displayName][CO]
string
filter[email][EQ]
string
filter[email][CO]
string
filter[active][EQ]
boolean
filter[externalId][PR]
boolean
filter[system][EQ]
boolean
filter[invitationPending][EQ]
boolean
filter[deleted][EQ]
string (userDeletedQueryOption)
Enum: "deletedOnly" "notDeletedOnly" "all"
filter[deleted][LT]
string <date-time>
filter[deleted][GT]
string <date-time>
filter[_created][LT]
string <date-time>
filter[_created][GT]
string <date-time>
filter[_modified][LT]
string <date-time>
filter[_modified][GT]
string <date-time>
page[offset]
integer
page[limit]
integer
sort
string
Enum: "userName" "-userName" "displayName" "-displayName" "_created" "-_created" "_modified" "-_modified"
fields
Array of strings (userField)
Items Enum: "_id" "_created" "_modified" "externalId" "userName" "displayName" "active" "email" "unixHomeDirectory" "unixUserName" "userPrincipalName" "invitationPending" "deleted"
excludeFields
Array of strings (userField)
Items Enum: "_id" "_created" "_modified" "externalId" "userName" "displayName" "active" "email" "unixHomeDirectory" "unixUserName" "userPrincipalName" "invitationPending" "deleted"

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ]
}

createUser

Creates a new user entity.

Authorizations:
bearerAuth
Request Body schema: application/json
_id
string
_created
string <date-time>
_modified
string <date-time>
externalId
string
system
boolean
userName
string
displayName
string
active
boolean
email
string
unixHomeDirectory
string
unixUserName
string
userPrincipalName
string
invitationPending
boolean
invitationExpiry
string <date-time>
deleted
string <date-time>
password
required
string

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "system": true,
  • "userName": "string",
  • "displayName": "string",
  • "active": true,
  • "email": "string",
  • "unixHomeDirectory": "string",
  • "unixUserName": "string",
  • "userPrincipalName": "string",
  • "invitationPending": true,
  • "invitationExpiry": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "system": true,
  • "userName": "string",
  • "displayName": "string",
  • "active": true,
  • "email": "string",
  • "unixHomeDirectory": "string",
  • "unixUserName": "string",
  • "userPrincipalName": "string",
  • "invitationPending": true,
  • "invitationExpiry": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Returns a specific user by unique ID

Authorizations:
bearerAuth
path Parameters
userId
required
string

Internal unique ID of the user

query Parameters
fields
Array of strings (userField)
Items Enum: "_id" "_created" "_modified" "externalId" "userName" "displayName" "active" "email" "unixHomeDirectory" "unixUserName" "userPrincipalName" "invitationPending" "deleted"
excludeFields
Array of strings (userField)
Items Enum: "_id" "_created" "_modified" "externalId" "userName" "displayName" "active" "email" "unixHomeDirectory" "unixUserName" "userPrincipalName" "invitationPending" "deleted"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "system": true,
  • "userName": "string",
  • "displayName": "string",
  • "active": true,
  • "email": "string",
  • "unixHomeDirectory": "string",
  • "unixUserName": "string",
  • "userPrincipalName": "string",
  • "invitationPending": true,
  • "invitationExpiry": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Updates the definition of a user

Authorizations:
bearerAuth
path Parameters
userId
required
string

Internal unique ID of the user

Request Body schema: application/json
_id
string
_created
string <date-time>
_modified
string <date-time>
externalId
string
system
boolean
userName
string
displayName
string
active
boolean
email
string
unixHomeDirectory
string
unixUserName
string
userPrincipalName
string
invitationPending
boolean
invitationExpiry
string <date-time>
deleted
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "system": true,
  • "userName": "string",
  • "displayName": "string",
  • "active": true,
  • "email": "string",
  • "unixHomeDirectory": "string",
  • "unixUserName": "string",
  • "userPrincipalName": "string",
  • "invitationPending": true,
  • "invitationExpiry": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "system": true,
  • "userName": "string",
  • "displayName": "string",
  • "active": true,
  • "email": "string",
  • "unixHomeDirectory": "string",
  • "unixUserName": "string",
  • "userPrincipalName": "string",
  • "invitationPending": true,
  • "invitationExpiry": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Updates the definition of a user using JSON Patch

Authorizations:
bearerAuth
path Parameters
userId
required
string

Internal unique ID of the user

Request Body schema: application/json-patch+json
Array ()
op
required
string
Enum: "add" "remove" "replace"

The operation to be performed

path
required
string

A JSON-Pointer

value
any

The value to be used within the operations.

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "system": true,
  • "userName": "string",
  • "displayName": "string",
  • "active": true,
  • "email": "string",
  • "unixHomeDirectory": "string",
  • "unixUserName": "string",
  • "userPrincipalName": "string",
  • "invitationPending": true,
  • "invitationExpiry": "2019-08-24T14:15:22Z",
  • "deleted": "2019-08-24T14:15:22Z"
}

Deletes a specific user by ID

Authorizations:
bearerAuth
path Parameters
userId
required
string

Internal unique ID of the user

Responses

Response samples

Content type
application/json
{
  • "msg": "string"
}

Returns the list of groups that a user is a member of

Authorizations:
bearerAuth
path Parameters
userId
required
string

Internal unique ID of the user

query Parameters
filter[membershipType][EQ]
string (membershipType)
Enum: "direct" "indirect"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a structure containing the operating system user information for the user, if any

Authorizations:
bearerAuth
path Parameters
userId
required
string

Internal unique ID of the user

Responses

Response samples

Content type
application/json
{
  • "userName": "string",
  • "userPrincipalName": "string",
  • "unixHomeDirectory": "string"
}

Queries current group instances

Authorizations:
bearerAuth
query Parameters
filter[_id][EQ]
string
filter[_id][IN]
Array of strings
filter[name][EQ]
string
filter[name][CO]
string
filter[externalId][PR]
boolean
filter[_created][LT]
string <date-time>
filter[_created][GT]
string <date-time>
filter[_modified][LT]
string <date-time>
filter[_modified][GT]
string <date-time>
filter[system][EQ]
boolean
page[offset]
integer
page[limit]
integer
sort
string
Enum: "name" "-name" "_created" "-_created" "_modified" "-_modified"
fields
Array of strings (groupField)
Items Enum: "_id" "_created" "_modified" "externalId" "name"
excludeFields
Array of strings (groupField)
Items Enum: "_id" "_created" "_modified" "externalId" "name"

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ]
}

createGroup

Creates a new group entity.

Authorizations:
bearerAuth
Request Body schema: application/json
_id
string
_created
string <date-time>
_modified
string <date-time>
externalId
string
system
boolean
name
string

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "system": true,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "system": true,
  • "name": "string"
}

Returns a specific group by unique ID

Authorizations:
bearerAuth
path Parameters
groupId
required
string

Internal unique ID of the group

query Parameters
fields
Array of strings (groupField)
Items Enum: "_id" "_created" "_modified" "externalId" "name"
excludeFields
Array of strings (groupField)
Items Enum: "_id" "_created" "_modified" "externalId" "name"

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "system": true,
  • "name": "string"
}

Replaces the definition of a group

Authorizations:
bearerAuth
path Parameters
groupId
required
string

Internal unique ID of the group

Request Body schema: application/json
_id
string
_created
string <date-time>
_modified
string <date-time>
externalId
string
system
boolean
name
string

Responses

Request samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "system": true,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "system": true,
  • "name": "string"
}

Updates the definition of a group using JSON Patch

Authorizations:
bearerAuth
path Parameters
groupId
required
string

Internal unique ID of the group

Request Body schema: application/json-patch+json
Array ()
op
required
string
Enum: "add" "remove" "replace"

The operation to be performed

path
required
string

A JSON-Pointer

value
any

The value to be used within the operations.

Responses

Request samples

Content type
application/json-patch+json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_id": "string",
  • "_created": "2019-08-24T14:15:22Z",
  • "_modified": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "system": true,
  • "name": "string"
}

Deletes a specific group by ID

Authorizations:
bearerAuth
path Parameters
groupId
required
string

Internal unique ID of the group

Responses

Response samples

Content type
application/json
{
  • "msg": "string"
}

Returns the list of members of the group

Authorizations:
bearerAuth
path Parameters
groupId
required
string

Internal unique ID of the group

query Parameters
filter[membershipType][EQ]
string (membershipType)
Enum: "direct" "indirect"
filter[principalType][EQ]
string (principalType)
Enum: "User" "Group"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Modifies the group membership list

Authorizations:
bearerAuth
path Parameters
groupId
required
string

Internal unique ID of the group

Request Body schema: application/json
Array ()
op
required
string
Enum: "add" "remove"
id
string
principalType
string (principalType)
Enum: "User" "Group"
name
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "msg": "string"
}

Returns the list of groups that a group is a member of

Authorizations:
bearerAuth
path Parameters
groupId
required
string

Internal unique ID of the group

query Parameters
filter[membershipType][EQ]
string (membershipType)
Enum: "direct" "indirect"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Queries current principal instances

Authorizations:
bearerAuth
query Parameters
filter[_id][EQ]
string
filter[_id][IN]
Array of strings
filter[_type][EQ]
string (principalType)
Enum: "User" "Group"
filter[displayName][EQ]
string
filter[displayName][CO]
string
filter[displayName][SW]
string
filter[external][EQ]
boolean
filter[system][EQ]
boolean
filter[deleted][EQ]
string (userDeletedQueryOption)
Enum: "deletedOnly" "notDeletedOnly" "all"

Only applicable when querying users

filter[deleted][LT]
string <date-time>

Only applicable when querying users

filter[deleted][GT]
string <date-time>

Only applicable when querying users

page[offset]
integer
page[limit]
integer
sort
string
Enum: "displayName" "-displayName"

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ]
}

Returns a specific principal by ID

Authorizations:
bearerAuth
path Parameters
principalId
required
string

Responses

Response samples

Content type
application/json
{
  • "_type": "User",
  • "_id": "string",
  • "displayName": "string",
  • "name": "string",
  • "external": true,
  • "system": true
}

Returns the list of groups that a principal is a member of

Authorizations:
bearerAuth
path Parameters
principalId
required
string
query Parameters
filter[membershipType][EQ]
string (membershipType)
Enum: "direct" "indirect"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createUserInvitation

Authorizations:
bearerAuth
Request Body schema: application/json
userName
required
string
displayName
required
string
email
required
string

Responses

Request samples

Content type
application/json
{
  • "userName": "string",
  • "displayName": "string",
  • "email": "string"
}

validateUserInvitationToken

Authorizations:
bearerAuth
Request Body schema: application/json
token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "response": "Valid"
}

resendInvitationEmail

Authorizations:
bearerAuth
Request Body schema: application/json
userId
required
string

Responses

Request samples

Content type
application/json
{
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "msg": "string"
}

completeUserRegistration

Authorizations:
bearerAuth
Request Body schema: application/json
token
required
string
displayName
required
string
userName
required
string
password
string
jwtSubject
string

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "displayName": "string",
  • "userName": "string",
  • "password": "string",
  • "jwtSubject": "string"
}

checkUsernameAvailability

Authorizations:
bearerAuth
Request Body schema: application/json
token
required
string
userName
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "available": true
}

createPasswordResetToken

Authorizations:
bearerAuth
Request Body schema: application/json
emailOrUserName
required
string

Responses

Request samples

Content type
application/json
{
  • "emailOrUserName": "string"
}

validatePasswordResetToken

Authorizations:
bearerAuth
Request Body schema: application/json
token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "response": "Valid"
}

completePasswordReset

Authorizations:
bearerAuth
Request Body schema: application/json
password
required
string
token
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "msg": "string"
}

Changes the password for the calling user

Authorizations:
bearerAuth
Request Body schema: application/json
currentPassword
required
string
newPassword
required
string

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "string",
  • "newPassword": "string"
}

Response samples

Content type
application/json
{
  • "msg": "string"
}

Performs password based login

Authorizations:
bearerAuth
Request Body schema: application/json
username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "expiresIn": 0
}

Generates a login token for a different user

Authorizations:
bearerAuth
Request Body schema: application/json
userId
required
string

Responses

Request samples

Content type
application/json
{
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "expiresIn": 0
}

Returns the claims from the JWT passed as the bearer token

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "claims": { }
}