Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Verify an invite token

POST /tokens/verify_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 - defaults to the requesting client's IP,
  • consumer's identity token - consumer defaults to the authenticated client if valid token credentials are sent with this request, or null otherwise,
  • 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 -X POST https://$ZONE_HOST/api/v3/onezone/tokens/verify_invite_token \
-H 'Content-type: application/json' \
-d '{
  "token": "MDAxNmxvY2F00aW9uIHJlZ2lzdHJ5CjAwM2JpZGVudGlmaW",
  "peerIp": "38.190.241.12",
  "expectedInviteType": "userJoinGroup"
}'

{
  "subject": {
    "type": "user",
    "id": "1b510f18b3b05611871c0acdffa9aed4"
  },
  "ttl": 3600
}

Request body

application/json

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:
userJoinGroup groupJoinGroup userJoinSpace groupJoinSpace supportSpace harvesterJoinSpace registerOneprovider userJoinCluster groupJoinCluster userJoinHarvester groupJoinHarvester spaceJoinHarvester

Request Examples

application/json 
{
  "token": "MDAxNmxvY2F00aW9uIHJlZ2lzdHJ5CjAwM2JpZGVudGlmaW",
  "peerIp": "38.190.241.12",
  "consumerToken": "MDAzYmlkZW50aWZpZXIgOEhmSEFSSGdrbHFCa1pWSTRsNk5",
  "expectedInviteType": "userJoinGroup"
}

Responses

application/json
200

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.
type
string

Type of the subject

Enum:
user oneprovider
id
string

Id of the subject

ttl
integer

Token's TTL in seconds (or null if infinite)

Example

application/json
{
  "subject": {
    "type": "user",
    "id": "1b510f18b3b05611871c0acdffa9aed4"
  },
  "ttl": 3600
}
400

Invalid request.

Property
Type & Description
error
object

Object describing an error.
id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
401

Authentication error.

Property
Type & Description
error
object

Object describing an error.
id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
403

Authorization error.

Property
Type & Description
error
object

Object describing an error.
id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
404

Resource not found.

Property
Type & Description
error
object

Object describing an error.
id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
500

Internal server Error.

Property
Type & Description
error
object

Object describing an error.
id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}