Get My User Metadata By Key

GET 
/users/me/metadata/:key

Returns a metadata value by a specific key of the authenticated user. Metadata is a key value list with additional information needed on the user.

Request

Path Parameters

key stringrequired

Responses

200

A successful response.

application/json

Schema

Schema

metadata

object

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

creationDate date-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)

key string

metadata key

value byte

metadata value is base64 encoded, make sure to decode to get the value

Example (from schema)

{
  "metadata": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-22T16:27:04.152Z",
      "changeDate": "2024-11-22T16:27:04.152Z",
      "resourceOwner": "69629023906488334"
    },
    "key": "key1",
    "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
  }
}

application/grpc

Schema

Schema

metadata

object

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

creationDate date-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)

key string

metadata key

value byte

metadata value is base64 encoded, make sure to decode to get the value

Example (from schema)

{
  "metadata": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-22T16:27:04.152Z",
      "changeDate": "2024-11-22T16:27:04.152Z",
      "resourceOwner": "69629023906488334"
    },
    "key": "key1",
    "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
  }
}

application/grpc-web+proto

Schema

Schema

metadata

object

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

creationDate date-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)

key string

metadata key

value byte

metadata value is base64 encoded, make sure to decode to get the value

Example (from schema)

{
  "metadata": {
    "details": {
      "sequence": "2",
      "creationDate": "2024-11-22T16:27:04.153Z",
      "changeDate": "2024-11-22T16:27:04.153Z",
      "resourceOwner": "69629023906488334"
    },
    "key": "key1",
    "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
  }
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...