Skip to main content
POST
/
api
/
sys
/
refreshtokens
Create RefreshToken
curl --request POST \
  --url https://spaces.nexudus.com/api/sys/refreshtokens \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Subject": "<string>",
  "ClientId": "<string>",
  "ExpiresOn": "<string>",
  "ProtectedTicket": "<string>",
  "TicketHash": "<string>",
  "TicketSalt": "<string>"
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A RefreshToken represents an OAuth refresh token issued to maintain authenticated sessions. Refresh tokens allow clients to obtain new access tokens without re-authentication.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the RefreshToken-Create role.

​
Request Body

​
Required Fields

​
Subject
string
required
The subject value for this refresh token.
​
ClientId
string
required
ID of the client associated with this record.
​
ExpiresOn
string
required
Date/time value for expires on.
​
ProtectedTicket
string
required
The protected ticket value for this refresh token.
​
TicketHash
string
required
The ticket hash value for this refresh token.
​
TicketSalt
string
required
The ticket salt value for this refresh token.

​
Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/refreshtokens" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "Subject": "",
    "ClientId": "",
    "ExpiresOn": "2025-01-15T10:30:00Z",
    "ProtectedTicket": "",
    "TicketHash": "",
    "TicketSalt": ""
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the creation.
​
Value
object
Contains the Id of the newly created record.
​
WasSuccessful
boolean
true if the refreshtoken was created successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "RefreshToken was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

​
400

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Subject: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Subject"
    }
  ],
  "WasSuccessful": false
}