Reference

Refreshtoken

The refreshtoken object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this refreshtoken
ClientId: string required
ExpiresOn: DateTime required
ProtectedTicket: string required
Subject: string required
TicketHash: string required
TicketSalt: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this refreshtoken
SystemId: string optional api-only
User defined data about this refreshtoken. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "ClientId": "Client Id",
  "ExpiresOn": 2020-01-01T21:03:54Z,
  "ProtectedTicket": "Protected Ticket",
  "Subject": "Subject",
  "TicketHash": "Ticket Hash",
  "TicketSalt": "Ticket Salt",
  "UniqueId": "d43b07f3-1d88-43c4-beaa-12aad76c9717",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a RefreshToken

This endpoint allows you to GET a list of refreshtokens based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/sys/refreshtokens?...

πŸ”’ Requires role "RefreshToken-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Id
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search refreshtoken records based on their different properties.
Id number
?Id=12345678
RefreshToken_ClientId string
?RefreshToken_ClientId=...
RefreshToken_ExpiresOn DateTime
?RefreshToken_ExpiresOn=...
RefreshToken_ProtectedTicket string
?RefreshToken_ProtectedTicket=...
RefreshToken_Subject string
?RefreshToken_Subject=...
RefreshToken_TicketHash string
?RefreshToken_TicketHash=...
RefreshToken_TicketSalt string
?RefreshToken_TicketSalt=...

Range search querystring parameters
Lets you search refreshtoken records based on a range of date or numeric values.
To_RefreshToken_CreatedOn date
?To_RefreshToken_CreatedOn=2010-01-01T20:32
From_RefreshToken_CreatedOn date
?From_RefreshToken_CreatedOn=2010-01-01T20:32
To_RefreshToken_UpdatedOn date
?To_RefreshToken_UpdatedOn=2010-01-01T20:32
From_RefreshToken_UpdatedOn date
?From_RefreshToken_UpdatedOn=2010-01-01T20:32
To_RefreshToken_ExpiresOn date
?To_RefreshToken_ExpiresOn=2010-01-01T20:32
From_RefreshToken_ExpiresOn date
?From_RefreshToken_ExpiresOn=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/sys/refreshtokens?RefreshToken_FullName=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Subject": "Subject",
        "ClientId": "Client Id",
        "ExpiresOn": 2020-01-01T21:03:54Z,
        "ProtectedTicket": "Protected Ticket",
        "TicketHash": "Ticket Hash",
        "TicketSalt": "Ticket Salt",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "d83ecded-411b-4c79-ab81-fc6a19d2260e",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find RefreshTokens by IDs

Gets one or more refreshtoken records based on their Id.
GET https://spaces.nexudus.com/api/sys/refreshtokens?RefreshToken_Id=[:id1,:id2,...]

πŸ”’ Requires role "RefreshToken-List"

Querystring parameters
RefreshToken_Id: array requried
?RefreshToken_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/sys/refreshtokens?RefreshToken_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Subject": "Subject",
        "ClientId": "Client Id",
        "ExpiresOn": 2020-01-01T21:03:54Z,
        "ProtectedTicket": "Protected Ticket",
        "TicketHash": "Ticket Hash",
        "TicketSalt": "Ticket Salt",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "df8e8bfd-7acb-4105-ac11-15e54f8cf317",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single RefreshToken by Id

Gets one refreshtoken record by its Id.
GET https://spaces.nexudus.com/api/sys/refreshtokens/:Id

πŸ”’ Requires role "RefreshToken-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/sys/refreshtokens/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "ClientId": "Client Id",
  "ExpiresOn": 2020-01-01T21:03:54Z,
  "ProtectedTicket": "Protected Ticket",
  "Subject": "Subject",
  "TicketHash": "Ticket Hash",
  "TicketSalt": "Ticket Salt",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "d1296f9c-1dab-431b-ab48-238aafe6c20f",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new RefreshToken

Creates a new refreshtoken.
POST https://spaces.nexudus.com/api/sys/refreshtokens

πŸ”’ Requires role "RefreshToken-Create"

Body parameters
Subject: string required
ClientId: string required
ExpiresOn: DateTime required
ProtectedTicket: string required
TicketHash: string required
TicketSalt: string required

Example request

POST https://spaces.nexudus.com/api/sys/refreshtokens
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Subject": "Subject",
    "ClientId": "Client Id",
    "ExpiresOn": 2020-01-01T21:03:54Z,
    "ProtectedTicket": "Protected Ticket",
    "TicketHash": "Ticket Hash",
    "TicketSalt": "Ticket Salt",
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Update RefreshToken

Updates an existing refreshtoken.
PUT https://spaces.nexudus.com/api/sys/refreshtokens

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "RefreshToken-Edit"

Body parameters
Id: number required
The unique Id of the refreshtoken to update.
Subject: string cleared if missing
ClientId: string cleared if missing
ExpiresOn: DateTime cleared if missing
ProtectedTicket: string cleared if missing
TicketHash: string cleared if missing
TicketSalt: string cleared if missing

Example request

PUT https://spaces.nexudus.com/api/sys/refreshtokens
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "Subject": "Subject",
    "ClientId": "Client Id",
    "ExpiresOn": 2020-01-01T21:03:54Z,
    "ProtectedTicket": "Protected Ticket",
    "TicketHash": "Ticket Hash",
    "TicketSalt": "Ticket Salt",
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Delete RefreshToken

Deletes an existing refreshtoken by its Id.
DELETE https://spaces.nexudus.com/api/sys/refreshtokens/:Id

πŸ”’ Requires role "RefreshToken-Delete"

URL parameters
Id: number required
The unique Id of the refreshtoken to update.

Example request

DELETE https://spaces.nexudus.com/api/sys/refreshtokens/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}


Commands

Commands allow to perform actions against one or more refreshtoken records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for refreshtoken records.
GET https://spaces.nexudus.com/api/sys/refreshtokens/commands

Example request

GET https://spaces.nexudus.com/api/sys/refreshtokens/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more refreshtoken record IDs.
POST https://spaces.nexudus.com/api/sys/refreshtokens/runacommand
πŸ”’ Requires role "RefreshToken-Edit"

Example request

POST https://spaces.nexudus.com/api/sys/refreshtokens/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.