Bulk Add Project Role

Add a list of roles to a project. The keys must be unique within the project.

Path Parameters

projectId string required

Header Parameters

x-zitadel-orgid string

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

application/json

application/grpc

application/grpc-web+proto

Request Body required

roles object[]
Array [
key string
displayName string
group string
]

Request Body required

roles object[]
Array [
key string
displayName string
group string
]

Request Body required

roles object[]
Array [
key string
displayName string
group string
]

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-03-27T06:43:21.401Z",
    "changeDate": "2024-03-27T06:43:21.401Z",
    "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-03-27T06:43:21.401Z",
    "changeDate": "2024-03-27T06:43:21.401Z",
    "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-03-27T06:43:21.401Z",
    "changeDate": "2024-03-27T06:43:21.401Z",
    "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 /projects/:projectId/roles/_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

projectId — path required

x-zitadel-orgid — header

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "roles": [
    {
      "key": "ADMIN",
      "display_name": "Administrator"
    },
    {
      "key": "SUPPORT",
      "display_name": "Supporter"
    }
  ]
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/roles/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "roles": [
    {
      "key": "ADMIN",
      "display_name": "Administrator"
    },
    {
      "key": "SUPPORT",
      "display_name": "Supporter"
    }
  ]
}'

python / requests

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/roles/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "roles": [
    {
      "key": "ADMIN",
      "display_name": "Administrator"
    },
    {
      "key": "SUPPORT",
      "display_name": "Supporter"
    }
  ]
}'

go / native

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/roles/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "roles": [
    {
      "key": "ADMIN",
      "display_name": "Administrator"
    },
    {
      "key": "SUPPORT",
      "display_name": "Supporter"
    }
  ]
}'

nodejs / axios

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/roles/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "roles": [
    {
      "key": "ADMIN",
      "display_name": "Administrator"
    },
    {
      "key": "SUPPORT",
      "display_name": "Supporter"
    }
  ]
}'

ruby / Net::HTTP

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/roles/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "roles": [
    {
      "key": "ADMIN",
      "display_name": "Administrator"
    },
    {
      "key": "SUPPORT",
      "display_name": "Supporter"
    }
  ]
}'

csharp / RestSharp

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/roles/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "roles": [
    {
      "key": "ADMIN",
      "display_name": "Administrator"
    },
    {
      "key": "SUPPORT",
      "display_name": "Supporter"
    }
  ]
}'

php / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/roles/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "roles": [
    {
      "key": "ADMIN",
      "display_name": "Administrator"
    },
    {
      "key": "SUPPORT",
      "display_name": "Supporter"
    }
  ]
}'

java / OkHttp

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/roles/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "roles": [
    {
      "key": "ADMIN",
      "display_name": "Administrator"
    },
    {
      "key": "SUPPORT",
      "display_name": "Supporter"
    }
  ]
}'

powershell / RestMethod

curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/roles/_bulk' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "roles": [
    {
      "key": "ADMIN",
      "display_name": "Administrator"
    },
    {
      "key": "SUPPORT",
      "display_name": "Supporter"
    }
  ]
}'