Bulk Set User Metadata

Add or update multiple metadata values for a user. Make sure the values are base64 encoded.

Path Parameters

id string required

Header Parameters

x-zitadel-orgid string

The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data.

application/json

application/grpc

application/grpc-web+proto

Request Body required

metadata object[]
The values have to be base64 encoded.
Array [
key string
value byte
]

Request Body required

metadata object[]
The values have to be base64 encoded.
Array [
key string
value byte
]

Request Body required

metadata object[]
The values have to be base64 encoded.
Array [
key string
value byte
]

Responses

• 200
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

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

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-05-10T13:32:04.327Z",
    "changeDate": "2024-05-10T13:32:04.327Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

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

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-05-10T13:32:04.327Z",
    "changeDate": "2024-05-10T13:32:04.327Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

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

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-05-10T13:32:04.327Z",
    "changeDate": "2024-05-10T13:32:04.327Z",
    "resourceOwner": "69629023906488334"
  }
}

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

POST /users/:id/metadata/_bulk

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL

https://$CUSTOM-DOMAIN/management/v1

Bearer Token

id — path required

x-zitadel-orgid — header

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "metadata": [
    {
      "key": "test1",
      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
    },
    {
      "key": "test2",
      "value": "VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU="
    }
  ]
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/users/:id/metadata/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "metadata": [
    {
      "key": "test1",
      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
    },
    {
      "key": "test2",
      "value": "VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU="
    }
  ]
}'

python / requests

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/users/:id/metadata/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "metadata": [
    {
      "key": "test1",
      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
    },
    {
      "key": "test2",
      "value": "VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU="
    }
  ]
}'

go / native

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/users/:id/metadata/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "metadata": [
    {
      "key": "test1",
      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
    },
    {
      "key": "test2",
      "value": "VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU="
    }
  ]
}'

nodejs / axios

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/users/:id/metadata/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "metadata": [
    {
      "key": "test1",
      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
    },
    {
      "key": "test2",
      "value": "VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU="
    }
  ]
}'

ruby / Net::HTTP

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/users/:id/metadata/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "metadata": [
    {
      "key": "test1",
      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
    },
    {
      "key": "test2",
      "value": "VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU="
    }
  ]
}'

csharp / RestSharp

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/users/:id/metadata/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "metadata": [
    {
      "key": "test1",
      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
    },
    {
      "key": "test2",
      "value": "VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU="
    }
  ]
}'

php / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/users/:id/metadata/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "metadata": [
    {
      "key": "test1",
      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
    },
    {
      "key": "test2",
      "value": "VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU="
    }
  ]
}'

java / OkHttp

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/users/:id/metadata/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "metadata": [
    {
      "key": "test1",
      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
    },
    {
      "key": "test2",
      "value": "VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU="
    }
  ]
}'

powershell / RestMethod

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/users/:id/metadata/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "metadata": [
    {
      "key": "test1",
      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
    },
    {
      "key": "test2",
      "value": "VGhpcyBpcyBteSBzZWNvbmQgdmFsdWU="
    }
  ]
}'