Add IAM Member
POSThttps://$CUSTOM-DOMAIN/admin/v1/members
Members are users with permission to administrate ZITADEL on different levels. This request adds a new user to the members list with one or multiple roles.
Request​
- application/json
- application/grpc
- application/grpc-web+proto
Body
required
Possible values: non-empty
and <= 200 characters
If no roles are provided the user won't have any rights
Body
required
Possible values: non-empty
and <= 200 characters
If no roles are provided the user won't have any rights
Body
required
Possible values: non-empty
and <= 200 characters
If no roles are provided the user won't have any rights
Responses​
- 200
- 400
- 403
- 404
- default
Member added to the IAM
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object
{
"details": {
"sequence": "2",
"creationDate": "2025-03-25T07:19:32.361Z",
"changeDate": "2025-03-25T07:19:32.361Z",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details
object
{
"details": {
"sequence": "2",
"creationDate": "2025-03-25T07:19:32.361Z",
"changeDate": "2025-03-25T07:19:32.361Z",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details
object
{
"details": {
"sequence": "2",
"creationDate": "2025-03-25T07:19:32.361Z",
"changeDate": "2025-03-25T07:19:32.361Z",
"resourceOwner": "69629023906488334"
}
}
user not found or invalid roles
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L 'https://$CUSTOM-DOMAIN/admin/v1/members' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"userId": "69629023906488334",
"roles": [
"IAM_OWNER"
]
}'