Verify an invite token
Verifies an invite token provided in serialized form. Upon success, returns the token's subject. Does not check if the token can be effectively consumed (only if prerequisites are satisfied - the token itself is valid).
Optionally, contextual information that may be required to verify token caveats can be provided in the request body: IP address of the token bearer, consumer's identity token and the expected invite token type, which will cause verification to fail if it does not match the actual token type. If not specified, the procedure will check if given token is an invite token of any type.
If the token cannot be positively verified, HTTP code 4xx is returned with an error describing the reason of failure.
This operation has public access.
Example cURL requests
Verify an invite token
curl -d '{
"token": "MDAxNmxvY2F00aW9uIHJlZ2lzdHJ5CjAwM2JpZGVudGlmaW",
"peerIp": "38.190.241.12",
"expectedInviteType": "userJoinGroup"
}' \
-H 'Content-type: application/json' \
https://$HOST/api/v3/onezone/tokens/verify_invite_token
Request body
The token to be verified and optional parameters.
| Property | Type & Description |
|---|---|
token string (SerializedToken) The token in serialized form. | |
peerIp string The IP address of the token bearer. | |
consumerToken string (SerializedToken) Identity token of the consumer that wishes to use the token being verified. | |
expectedInviteType string Expected type of the invite token - verification will not succeed if it does not match the actual invite token type. Enum: userJoinGroupgroupJoinGroupuserJoinSpacegroupJoinSpacesupportSpaceharvesterJoinSpaceregisterOneprovideruserJoinClustergroupJoinClusteruserJoinHarvestergroupJoinHarvesterspaceJoinHarvester | |
Request Examples
{
"token": "MDAxNmxvY2F00aW9uIHJlZ2lzdHJ5CjAwM2JpZGVudGlmaW",
"peerIp": "38.190.241.12",
"consumerToken": "MDAzYmlkZW50aWZpZXIgOEhmSEFSSGdrbHFCa1pWSTRsNk5",
"expectedInviteType": "userJoinGroup"
}Responses
Successful token verification result.
| Property | Type & Description | ||||
|---|---|---|---|---|---|
subject object (TokenPropertySubject) The subject of the token - the user or Oneprovider in whose name the token was issued. The bearer (consumer) of the token adopts the subject's identity when accessing services with that token.
| |||||
ttl integer Token's TTL in seconds (or null if infinite) | |||||
Example
{
"subject": {
"type": "user",
"id": "1b510f18b3b05611871c0acdffa9aed4"
},
"ttl": 3600
}Invalid request.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authentication error.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authorization error.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Resource not found.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Internal server Error.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}