ZiamBatchResources

Executes a non-atomic batch operation against one resource collection. Supported operations are create, update, delete, enable, disable, lock, unlock, and undelete. lock, unlock, and undelete are user-only operations. Items are executed one by one; earlier successful items are not rolled back when a later item fails. Each item returns its own success or error result.

POST/api/v1/ziam/resources/{collection}/batch

Operation ID

ZiamBatchResources

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

operation
StringRequired
Batch operation.
Example: disable
items
ListRequired
Batch items.
Example: (nested array)
- uuid
  String
  Resource uuid.
  Example: 11111111111111111111111111111111
- data
  Object
  Optional resource payload for create or update.
  uuid
  String
  Stable resource uuid. Generated when omitted for create.
  Example: 11111111111111111111111111111111
  name
  String
  Canonical resource name or user login name.
  Example: alice
  userName
  String
  Alias accepted for user login name. Normalized to name/userName for users.
  Example: alice
  displayName
  String
  Display name.
  Example: Alice
  description
  String
  Brief resource description shown on resource detail pages.
  Example: A brief description
  password
  String
  User password for create or password update. ZIAM hashes it into the internal credential and never returns it by list/detail APIs.
  Example: password123
  confirmPassword
  String
  Optional confirmation password. Must match password when present.
  Example: password123
  email
  String
  User email. Must be unique when supplied.
  Example: alice@example.com
  phone
  String
  Canonical E.164 phone number.
  Example: +8613800138000
  phoneNumber
  String
  Accepted alias for phone. ZIAM normalizes it to phone.
  Example: +8613800138000
  mobile
  String
  Accepted alias for phone. ZIAM normalizes it to phone.
  Example: +8613800138000
  source
  String
  Identity data source. ZIAM-created resources use ZIAM.
  Example: ZIAM
  status
  String
  Normalized status such as Enabled, Disabled, Locked, or Deleted.
  Example: Enabled
  credentialStatus
  Object
  Credential status for this resource
  type
  String
  Credential type.
  Example: password
  algorithm
  String
  Password verifier algorithm used internally by ZIAM.
  Example: argon2id
  version
  Long
  Credential schema or policy version.
  Example: 1
  status
  String
  Credential status.
  Example: Active
  mustChange
  Boolean
  Whether the user must change the password on next login.
  Example: false
  createdAt
  String
  Credential creation time.
  Example: 2026-06-17T01:00:00Z
  updatedAt
  String
  Last credential update time.
  Example: 2026-06-17T01:00:00Z
  createdAt
  String
  Normalized creation time returned by ZIAM when available.
  Example: 2026-06-16T10:00:00Z
  updatedAt
  String
  Normalized update time returned by ZIAM when available.
  Example: 2026-06-16T10:30:00Z
  lastLoginTime
  String
  Normalized last login time returned for users when available.
  Example: 2026-06-16T10:00:00Z
  lastLoginIp
  String
  Normalized last login IP returned for users when available.
  Example: 172.26.53.126
  groups
  List
  User list display aggregate. Groups related to the user.
  Example: (nested array)
  id
  String
  Stable ZIAM group id. Generated when omitted.
  Example: group-001
  uuid
  String
  Unique identifier of this resource
  Example: group-001
  source
  String
  Source for this resource
  Example: ZIAM
  ziamGroupId
  String
  ZIAM group id exposed for Cloud detail pages.
  Example: group-001
  name
  StringRequired
  Human-readable name of this resource
  Example: Operators
  displayName
  String
  Display name for this resource
  Example: Operators
  description
  String
  Description for this resource
  Example: A brief description
  projectId
  String
  Optional project id that owns this group.
  Example: project-001
  projectUuid
  String
  Project uuid for this resource
  Example: project-001
  enabled
  Boolean
  Enabled for this resource
  Example: true
  active
  Boolean
  Active for this resource
  Example: true
  members
  List
  Members for this resource
  Example: (nested array)
  value
  String
  Stable member uuid. ZIAM normalizes uuid into value.
  Example: 11111111111111111111111111111111
  uuid
  String
  Stable member uuid.
  Example: 11111111111111111111111111111111
  display
  String
  Display for this resource
  Example: Alice
  joinedAt
  String
  Time when the user was added to this organization or group.
  Example: 2026-06-16T10:00:00Z
  attributes
  Object
  Attributes for this resource
  Example: (nested object)
  resourceVersion
  Long
  Monotonic version used by downstream sync.
  Example: 10
  status
  String
  Normalized resource status.
  Example: Enabled
  createdAt
  String
  Creation time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  updatedAt
  String
  Update time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  userCount
  Long
  Count of direct user members.
  Example: 1
  directUserCount
  Long
  Count of direct user members.
  Example: 1
  projects
  List
  Projects related to this group.
  Example: (nested array)
  id
  String
  Stable ZIAM project id. Generated when omitted.
  Example: project-001
  uuid
  String
  Unique identifier of this resource
  Example: project-001
  source
  String
  Source for this resource
  Example: ZIAM
  ziamProjectId
  String
  ZIAM project id exposed for Cloud detail pages.
  Example: project-001
  name
  StringRequired
  Human-readable name of this resource
  Example: Project A
  displayName
  String
  Display name for this resource
  Example: Project A
  description
  String
  Description for this resource
  Example: A brief description
  organizationId
  String
  Organization or department id this project belongs to.
  Example: dept-001
  organizationUuid
  String
  Organization uuid for this resource
  Example: dept-001
  tenantId
  String
  Tenant or account id used by downstream products.
  Example: tenant-001
  tenantUuid
  String
  Tenant uuid for this resource
  Example: tenant-001
  accountId
  String
  Optional downstream account id.
  Example: account-001
  accountUuid
  String
  Account uuid for this resource
  Example: account-001
  linkAccountUuid
  String
  Optional Cloud project linked account uuid.
  Example: account-001
  enabled
  Boolean
  Enabled for this resource
  Example: true
  active
  Boolean
  Active for this resource
  Example: true
  attributes
  Object
  Attributes for this resource
  Example: (nested object)
  resourceVersion
  Long
  Monotonic version used by downstream sync.
  Example: 10
  status
  String
  Normalized resource status.
  Example: Enabled
  createdAt
  String
  Creation time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  updatedAt
  String
  Update time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  userCount
  Long
  Count of direct user members in this project.
  Example: 1
  directUserCount
  Long
  Count of direct user members in this project.
  Example: 1
  groupCount
  Long
  Count of user groups in this project.
  Example: 1
  userGroupCount
  Long
  Count of user groups in this project.
  Example: 1
  joinedAt
  String
  Relationship join time when the resource is returned as a related project row.
  Example: 2026-01-15T08:00:00Z
  projectNames
  List
  Names of projects related to this group.
  Example: item1,item2
  projectCount
  Long
  Count of projects related to this group.
  Example: 1
  joinedAt
  String
  Relationship join time when the resource is returned as a related group row.
  Example: 2026-01-15T08:00:00Z
  groupNames
  List
  User or group list display aggregate. Related group names.
  Example: item1,item2
  groupCount
  Long
  Display aggregate count of groups related to a project.
  Example: 1
  organizations
  List
  User list display aggregate. Direct organizations or departments related to the user.
  Example: (nested array)
  id
  String
  Stable ZIAM organization id. Generated when omitted.
  Example: dept-001
  uuid
  String
  Same identity as id for downstream SCIM receivers.
  Example: dept-001
  source
  String
  Identity data source. ZIAM-created resources use ZIAM.
  Example: ZIAM
  ziamDepartmentId
  String
  ZIAM department id exposed for Cloud detail pages.
  Example: dept-001
  name
  StringRequired
  Human-readable name of this resource
  Example: Engineering
  displayName
  String
  Display name for this resource
  Example: Engineering
  description
  String
  Description for this resource
  Example: A brief description
  parentId
  String
  Parent organization id.
  Example: company-001
  parentUuid
  String
  Same identity as parentId for downstream SCIM receivers.
  Example: company-001
  rootId
  String
  Optional root organization id.
  Example: company-001
  rootUuid
  String
  Root uuid for this resource
  Example: company-001
  type
  String
  Cloud organization type. Defaults to Company for root nodes and Department when a parent is present.
  Example: Department
  enabled
  Boolean
  Enabled for this resource
  Example: true
  active
  Boolean
  Alternative enabled flag accepted by SCIM receivers.
  Example: true
  members
  List
  Members for this resource
  Example: (nested array)
  value
  String
  Stable member uuid. ZIAM normalizes uuid into value.
  Example: 11111111111111111111111111111111
  uuid
  String
  Stable member uuid.
  Example: 11111111111111111111111111111111
  display
  String
  Display for this resource
  Example: Alice
  joinedAt
  String
  Time when the user was added to this organization or group.
  Example: 2026-06-16T10:00:00Z
  attributes
  Object
  Attributes for this resource
  Example: (nested object)
  resourceVersion
  Long
  Monotonic version used by downstream sync.
  Example: 10
  status
  String
  Normalized resource status.
  Example: Enabled
  createdAt
  String
  Creation time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  updatedAt
  String
  Update time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  ownerUuid
  String
  Organization owner user uuid when configured.
  Example: 11111111111111111111111111111111
  ownerName
  String
  Organization owner display name resolved by ZIAM when ownerUuid is available.
  Example: Alice
  departmentPath
  String
  Organization tree display path from root to this department.
  Example: Company/Engineering
  departmentPathNames
  List
  Organization tree display path as separate names.
  Example: item1,item2
  directUserCount
  Long
  Count of direct user members.
  Example: 1
  totalUserCount
  Long
  Count of direct members plus descendant organization members.
  Example: 10
  joinedAt
  String
  Relationship join time when the resource is returned as a related organization row.
  Example: 2026-01-15T08:00:00Z
  directOrganizations
  List
  User list display aggregate. Direct department memberships.
  Example: (nested array)
  id
  String
  Stable ZIAM organization id. Generated when omitted.
  Example: dept-001
  uuid
  String
  Same identity as id for downstream SCIM receivers.
  Example: dept-001
  source
  String
  Identity data source. ZIAM-created resources use ZIAM.
  Example: ZIAM
  ziamDepartmentId
  String
  ZIAM department id exposed for Cloud detail pages.
  Example: dept-001
  name
  StringRequired
  Human-readable name of this resource
  Example: Engineering
  displayName
  String
  Display name for this resource
  Example: Engineering
  description
  String
  Description for this resource
  Example: A brief description
  parentId
  String
  Parent organization id.
  Example: company-001
  parentUuid
  String
  Same identity as parentId for downstream SCIM receivers.
  Example: company-001
  rootId
  String
  Optional root organization id.
  Example: company-001
  rootUuid
  String
  Root uuid for this resource
  Example: company-001
  type
  String
  Cloud organization type. Defaults to Company for root nodes and Department when a parent is present.
  Example: Department
  enabled
  Boolean
  Enabled for this resource
  Example: true
  active
  Boolean
  Alternative enabled flag accepted by SCIM receivers.
  Example: true
  members
  List
  Members for this resource
  Example: (nested array)
  value
  String
  Stable member uuid. ZIAM normalizes uuid into value.
  Example: 11111111111111111111111111111111
  uuid
  String
  Stable member uuid.
  Example: 11111111111111111111111111111111
  display
  String
  Display for this resource
  Example: Alice
  joinedAt
  String
  Time when the user was added to this organization or group.
  Example: 2026-06-16T10:00:00Z
  attributes
  Object
  Attributes for this resource
  Example: (nested object)
  resourceVersion
  Long
  Monotonic version used by downstream sync.
  Example: 10
  status
  String
  Normalized resource status.
  Example: Enabled
  createdAt
  String
  Creation time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  updatedAt
  String
  Update time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  ownerUuid
  String
  Organization owner user uuid when configured.
  Example: 11111111111111111111111111111111
  ownerName
  String
  Organization owner display name resolved by ZIAM when ownerUuid is available.
  Example: Alice
  departmentPath
  String
  Organization tree display path from root to this department.
  Example: Company/Engineering
  departmentPathNames
  List
  Organization tree display path as separate names.
  Example: item1,item2
  directUserCount
  Long
  Count of direct user members.
  Example: 1
  totalUserCount
  Long
  Count of direct members plus descendant organization members.
  Example: 10
  joinedAt
  String
  Relationship join time when the resource is returned as a related organization row.
  Example: 2026-01-15T08:00:00Z
  organizationNames
  List
  Display aggregate of related organization names.
  Example: item1,item2
  departmentNames
  List
  Display aggregate of related department names.
  Example: item1,item2
  directOrganizationCount
  Long
  Display aggregate count of direct departments.
  Example: 1
  projects
  List
  User or group list display aggregate. Related projects.
  Example: (nested array)
  id
  String
  Stable ZIAM project id. Generated when omitted.
  Example: project-001
  uuid
  String
  Unique identifier of this resource
  Example: project-001
  source
  String
  Source for this resource
  Example: ZIAM
  ziamProjectId
  String
  ZIAM project id exposed for Cloud detail pages.
  Example: project-001
  name
  StringRequired
  Human-readable name of this resource
  Example: Project A
  displayName
  String
  Display name for this resource
  Example: Project A
  description
  String
  Description for this resource
  Example: A brief description
  organizationId
  String
  Organization or department id this project belongs to.
  Example: dept-001
  organizationUuid
  String
  Organization uuid for this resource
  Example: dept-001
  tenantId
  String
  Tenant or account id used by downstream products.
  Example: tenant-001
  tenantUuid
  String
  Tenant uuid for this resource
  Example: tenant-001
  accountId
  String
  Optional downstream account id.
  Example: account-001
  accountUuid
  String
  Account uuid for this resource
  Example: account-001
  linkAccountUuid
  String
  Optional Cloud project linked account uuid.
  Example: account-001
  enabled
  Boolean
  Enabled for this resource
  Example: true
  active
  Boolean
  Active for this resource
  Example: true
  attributes
  Object
  Attributes for this resource
  Example: (nested object)
  resourceVersion
  Long
  Monotonic version used by downstream sync.
  Example: 10
  status
  String
  Normalized resource status.
  Example: Enabled
  createdAt
  String
  Creation time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  updatedAt
  String
  Update time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  userCount
  Long
  Count of direct user members in this project.
  Example: 1
  directUserCount
  Long
  Count of direct user members in this project.
  Example: 1
  groupCount
  Long
  Count of user groups in this project.
  Example: 1
  userGroupCount
  Long
  Count of user groups in this project.
  Example: 1
  joinedAt
  String
  Relationship join time when the resource is returned as a related project row.
  Example: 2026-01-15T08:00:00Z
  projectNames
  List
  Display aggregate of related project names.
  Example: item1,item2
  projectCount
  Long
  Display aggregate count of related projects.
  Example: 1
  userCount
  Long
  Display aggregate count of direct user members.
  Example: 1
  directUserCount
  Long
  Display aggregate count of direct user members.
  Example: 1
  userGroupCount
  Long
  Display aggregate count of user groups related to a project.
  Example: 1
  ownerUuid
  String
  Organization owner user uuid when configured.
  Example: 11111111111111111111111111111111
  ownerName
  String
  Organization owner display name resolved from ownerUuid when available.
  Example: Alice
  departmentPath
  String
  Organization tree display path from root to this department.
  Example: Company/Engineering
  departmentPathNames
  List
  Organization tree display path as separate names.
  Example: item1,item2
  totalUserCount
  Long
  Organization display aggregate. Direct members plus descendant organization members.
  Example: 10
  groupUuids
  List
  Optional user create field. The new user is added to these groups after creation. Use an array even when only one group is selected.
  Example: item1,item2
  projectUuids
  List
  Optional user create field. The new user is added to these projects after creation. Use an array even when only one project is selected.
  Example: item1,item2
  organizationUuids
  List
  Optional user create field. The new user is added to these organizations or departments after creation. Use an array even when only one organization is selected.
  Example: item1,item2
  departmentUuids
  List
  Alias of organizationUuids for department tree UI. Use an array even when only one department is selected.
  Example: item1,item2
  joinedAt
  String
  Relationship creation time for membership resources.
  Example: 2026-01-15T08:00:00Z
  deletionTimestamp
  String
  Soft-delete timestamp for deleted users.
  Example: 2026-01-15T08:00:00Z
  deletionPhase
  String
  Deletion phase for soft-deleted users.
  Example: SoftDeleted
  retentionUntil
  String
  End of soft-delete retention window for deleted users.
  Example: 2026-01-15T08:00:00Z
  finalizers
  List
  Deletion finalizers applied to soft-deleted users.
  Example: item1,item2
- lockedUntil
  String
  Optional RFC3339 lock expiration time for user lock batch operation.
  Example: 2026-06-17T00:00:00Z

Responses

200 OK

On success, this API returns the following response structure.

status
String
Status for this resource
Example: ok
data
Object
Response payload data
- operation
  String
  Batch operation.
  Example: disable
- atomic
  Boolean
  Whether the batch is atomic. ZIAM returns false because items are executed one by one and successful items are not rolled back when another item fails.
  Example: false
- total
  Integer
  Total item count.
  Example: 2
- succeeded
  Integer
  Succeeded item count.
  Example: 1
- failed
  Integer
  Failed item count.
  Example: 1
- results
  List
  Per-item execution results.
  Example: (nested array)
  index
  Integer
  Item index in request.
  Example: 1
  uuid
  String
  Resource uuid when available.
  Example: 11111111111111111111111111111111
  status
  String
  Item execution status.
  Example: ok
  msg
  String
  Error message when status=error.
  Example: uuid is required
  data
  Object
  Resource response payload when status=ok.
  uuid
  String
  Stable resource uuid. Generated when omitted for create.
  Example: 11111111111111111111111111111111
  name
  String
  Canonical resource name or user login name.
  Example: alice
  userName
  String
  Alias accepted for user login name. Normalized to name/userName for users.
  Example: alice
  displayName
  String
  Display name.
  Example: Alice
  description
  String
  Brief resource description shown on resource detail pages.
  Example: A brief description
  password
  String
  User password for create or password update. ZIAM hashes it into the internal credential and never returns it by list/detail APIs.
  Example: password123
  confirmPassword
  String
  Optional confirmation password. Must match password when present.
  Example: password123
  email
  String
  User email. Must be unique when supplied.
  Example: alice@example.com
  phone
  String
  Canonical E.164 phone number.
  Example: +8613800138000
  phoneNumber
  String
  Accepted alias for phone. ZIAM normalizes it to phone.
  Example: +8613800138000
  mobile
  String
  Accepted alias for phone. ZIAM normalizes it to phone.
  Example: +8613800138000
  source
  String
  Identity data source. ZIAM-created resources use ZIAM.
  Example: ZIAM
  status
  String
  Normalized status such as Enabled, Disabled, Locked, or Deleted.
  Example: Enabled
  credentialStatus
  Object
  Credential status for this resource
  type
  String
  Credential type.
  Example: password
  algorithm
  String
  Password verifier algorithm used internally by ZIAM.
  Example: argon2id
  version
  Long
  Credential schema or policy version.
  Example: 1
  status
  String
  Credential status.
  Example: Active
  mustChange
  Boolean
  Whether the user must change the password on next login.
  Example: false
  createdAt
  String
  Credential creation time.
  Example: 2026-06-17T01:00:00Z
  updatedAt
  String
  Last credential update time.
  Example: 2026-06-17T01:00:00Z
  createdAt
  String
  Normalized creation time returned by ZIAM when available.
  Example: 2026-06-16T10:00:00Z
  updatedAt
  String
  Normalized update time returned by ZIAM when available.
  Example: 2026-06-16T10:30:00Z
  lastLoginTime
  String
  Normalized last login time returned for users when available.
  Example: 2026-06-16T10:00:00Z
  lastLoginIp
  String
  Normalized last login IP returned for users when available.
  Example: 172.26.53.126
  groups
  List
  User list display aggregate. Groups related to the user.
  Example: (nested array)
  id
  String
  Stable ZIAM group id. Generated when omitted.
  Example: group-001
  uuid
  String
  Unique identifier of this resource
  Example: group-001
  source
  String
  Source for this resource
  Example: ZIAM
  ziamGroupId
  String
  ZIAM group id exposed for Cloud detail pages.
  Example: group-001
  name
  StringRequired
  Human-readable name of this resource
  Example: Operators
  displayName
  String
  Display name for this resource
  Example: Operators
  description
  String
  Description for this resource
  Example: A brief description
  projectId
  String
  Optional project id that owns this group.
  Example: project-001
  projectUuid
  String
  Project uuid for this resource
  Example: project-001
  enabled
  Boolean
  Enabled for this resource
  Example: true
  active
  Boolean
  Active for this resource
  Example: true
  members
  List
  Members for this resource
  Example: (nested array)
  value
  String
  Stable member uuid. ZIAM normalizes uuid into value.
  Example: 11111111111111111111111111111111
  uuid
  String
  Stable member uuid.
  Example: 11111111111111111111111111111111
  display
  String
  Display for this resource
  Example: Alice
  joinedAt
  String
  Time when the user was added to this organization or group.
  Example: 2026-06-16T10:00:00Z
  attributes
  Object
  Attributes for this resource
  Example: (nested object)
  resourceVersion
  Long
  Monotonic version used by downstream sync.
  Example: 10
  status
  String
  Normalized resource status.
  Example: Enabled
  createdAt
  String
  Creation time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  updatedAt
  String
  Update time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  userCount
  Long
  Count of direct user members.
  Example: 1
  directUserCount
  Long
  Count of direct user members.
  Example: 1
  projects
  List
  Projects related to this group.
  Example: (nested array)
  id
  String
  Stable ZIAM project id. Generated when omitted.
  Example: project-001
  uuid
  String
  Unique identifier of this resource
  Example: project-001
  source
  String
  Source for this resource
  Example: ZIAM
  ziamProjectId
  String
  ZIAM project id exposed for Cloud detail pages.
  Example: project-001
  name
  StringRequired
  Human-readable name of this resource
  Example: Project A
  displayName
  String
  Display name for this resource
  Example: Project A
  description
  String
  Description for this resource
  Example: A brief description
  organizationId
  String
  Organization or department id this project belongs to.
  Example: dept-001
  organizationUuid
  String
  Organization uuid for this resource
  Example: dept-001
  tenantId
  String
  Tenant or account id used by downstream products.
  Example: tenant-001
  tenantUuid
  String
  Tenant uuid for this resource
  Example: tenant-001
  accountId
  String
  Optional downstream account id.
  Example: account-001
  accountUuid
  String
  Account uuid for this resource
  Example: account-001
  linkAccountUuid
  String
  Optional Cloud project linked account uuid.
  Example: account-001
  enabled
  Boolean
  Enabled for this resource
  Example: true
  active
  Boolean
  Active for this resource
  Example: true
  attributes
  Object
  Attributes for this resource
  Example: (nested object)
  resourceVersion
  Long
  Monotonic version used by downstream sync.
  Example: 10
  status
  String
  Normalized resource status.
  Example: Enabled
  createdAt
  String
  Creation time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  updatedAt
  String
  Update time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  userCount
  Long
  Count of direct user members in this project.
  Example: 1
  directUserCount
  Long
  Count of direct user members in this project.
  Example: 1
  groupCount
  Long
  Count of user groups in this project.
  Example: 1
  userGroupCount
  Long
  Count of user groups in this project.
  Example: 1
  joinedAt
  String
  Relationship join time when the resource is returned as a related project row.
  Example: 2026-01-15T08:00:00Z
  projectNames
  List
  Names of projects related to this group.
  Example: item1,item2
  projectCount
  Long
  Count of projects related to this group.
  Example: 1
  joinedAt
  String
  Relationship join time when the resource is returned as a related group row.
  Example: 2026-01-15T08:00:00Z
  groupNames
  List
  User or group list display aggregate. Related group names.
  Example: item1,item2
  groupCount
  Long
  Display aggregate count of groups related to a project.
  Example: 1
  organizations
  List
  User list display aggregate. Direct organizations or departments related to the user.
  Example: (nested array)
  id
  String
  Stable ZIAM organization id. Generated when omitted.
  Example: dept-001
  uuid
  String
  Same identity as id for downstream SCIM receivers.
  Example: dept-001
  source
  String
  Identity data source. ZIAM-created resources use ZIAM.
  Example: ZIAM
  ziamDepartmentId
  String
  ZIAM department id exposed for Cloud detail pages.
  Example: dept-001
  name
  StringRequired
  Human-readable name of this resource
  Example: Engineering
  displayName
  String
  Display name for this resource
  Example: Engineering
  description
  String
  Description for this resource
  Example: A brief description
  parentId
  String
  Parent organization id.
  Example: company-001
  parentUuid
  String
  Same identity as parentId for downstream SCIM receivers.
  Example: company-001
  rootId
  String
  Optional root organization id.
  Example: company-001
  rootUuid
  String
  Root uuid for this resource
  Example: company-001
  type
  String
  Cloud organization type. Defaults to Company for root nodes and Department when a parent is present.
  Example: Department
  enabled
  Boolean
  Enabled for this resource
  Example: true
  active
  Boolean
  Alternative enabled flag accepted by SCIM receivers.
  Example: true
  members
  List
  Members for this resource
  Example: (nested array)
  value
  String
  Stable member uuid. ZIAM normalizes uuid into value.
  Example: 11111111111111111111111111111111
  uuid
  String
  Stable member uuid.
  Example: 11111111111111111111111111111111
  display
  String
  Display for this resource
  Example: Alice
  joinedAt
  String
  Time when the user was added to this organization or group.
  Example: 2026-06-16T10:00:00Z
  attributes
  Object
  Attributes for this resource
  Example: (nested object)
  resourceVersion
  Long
  Monotonic version used by downstream sync.
  Example: 10
  status
  String
  Normalized resource status.
  Example: Enabled
  createdAt
  String
  Creation time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  updatedAt
  String
  Update time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  ownerUuid
  String
  Organization owner user uuid when configured.
  Example: 11111111111111111111111111111111
  ownerName
  String
  Organization owner display name resolved by ZIAM when ownerUuid is available.
  Example: Alice
  departmentPath
  String
  Organization tree display path from root to this department.
  Example: Company/Engineering
  departmentPathNames
  List
  Organization tree display path as separate names.
  Example: item1,item2
  directUserCount
  Long
  Count of direct user members.
  Example: 1
  totalUserCount
  Long
  Count of direct members plus descendant organization members.
  Example: 10
  joinedAt
  String
  Relationship join time when the resource is returned as a related organization row.
  Example: 2026-01-15T08:00:00Z
  directOrganizations
  List
  User list display aggregate. Direct department memberships.
  Example: (nested array)
  id
  String
  Stable ZIAM organization id. Generated when omitted.
  Example: dept-001
  uuid
  String
  Same identity as id for downstream SCIM receivers.
  Example: dept-001
  source
  String
  Identity data source. ZIAM-created resources use ZIAM.
  Example: ZIAM
  ziamDepartmentId
  String
  ZIAM department id exposed for Cloud detail pages.
  Example: dept-001
  name
  StringRequired
  Human-readable name of this resource
  Example: Engineering
  displayName
  String
  Display name for this resource
  Example: Engineering
  description
  String
  Description for this resource
  Example: A brief description
  parentId
  String
  Parent organization id.
  Example: company-001
  parentUuid
  String
  Same identity as parentId for downstream SCIM receivers.
  Example: company-001
  rootId
  String
  Optional root organization id.
  Example: company-001
  rootUuid
  String
  Root uuid for this resource
  Example: company-001
  type
  String
  Cloud organization type. Defaults to Company for root nodes and Department when a parent is present.
  Example: Department
  enabled
  Boolean
  Enabled for this resource
  Example: true
  active
  Boolean
  Alternative enabled flag accepted by SCIM receivers.
  Example: true
  members
  List
  Members for this resource
  Example: (nested array)
  value
  String
  Stable member uuid. ZIAM normalizes uuid into value.
  Example: 11111111111111111111111111111111
  uuid
  String
  Stable member uuid.
  Example: 11111111111111111111111111111111
  display
  String
  Display for this resource
  Example: Alice
  joinedAt
  String
  Time when the user was added to this organization or group.
  Example: 2026-06-16T10:00:00Z
  attributes
  Object
  Attributes for this resource
  Example: (nested object)
  resourceVersion
  Long
  Monotonic version used by downstream sync.
  Example: 10
  status
  String
  Normalized resource status.
  Example: Enabled
  createdAt
  String
  Creation time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  updatedAt
  String
  Update time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  ownerUuid
  String
  Organization owner user uuid when configured.
  Example: 11111111111111111111111111111111
  ownerName
  String
  Organization owner display name resolved by ZIAM when ownerUuid is available.
  Example: Alice
  departmentPath
  String
  Organization tree display path from root to this department.
  Example: Company/Engineering
  departmentPathNames
  List
  Organization tree display path as separate names.
  Example: item1,item2
  directUserCount
  Long
  Count of direct user members.
  Example: 1
  totalUserCount
  Long
  Count of direct members plus descendant organization members.
  Example: 10
  joinedAt
  String
  Relationship join time when the resource is returned as a related organization row.
  Example: 2026-01-15T08:00:00Z
  organizationNames
  List
  Display aggregate of related organization names.
  Example: item1,item2
  departmentNames
  List
  Display aggregate of related department names.
  Example: item1,item2
  directOrganizationCount
  Long
  Display aggregate count of direct departments.
  Example: 1
  projects
  List
  User or group list display aggregate. Related projects.
  Example: (nested array)
  id
  String
  Stable ZIAM project id. Generated when omitted.
  Example: project-001
  uuid
  String
  Unique identifier of this resource
  Example: project-001
  source
  String
  Source for this resource
  Example: ZIAM
  ziamProjectId
  String
  ZIAM project id exposed for Cloud detail pages.
  Example: project-001
  name
  StringRequired
  Human-readable name of this resource
  Example: Project A
  displayName
  String
  Display name for this resource
  Example: Project A
  description
  String
  Description for this resource
  Example: A brief description
  organizationId
  String
  Organization or department id this project belongs to.
  Example: dept-001
  organizationUuid
  String
  Organization uuid for this resource
  Example: dept-001
  tenantId
  String
  Tenant or account id used by downstream products.
  Example: tenant-001
  tenantUuid
  String
  Tenant uuid for this resource
  Example: tenant-001
  accountId
  String
  Optional downstream account id.
  Example: account-001
  accountUuid
  String
  Account uuid for this resource
  Example: account-001
  linkAccountUuid
  String
  Optional Cloud project linked account uuid.
  Example: account-001
  enabled
  Boolean
  Enabled for this resource
  Example: true
  active
  Boolean
  Active for this resource
  Example: true
  attributes
  Object
  Attributes for this resource
  Example: (nested object)
  resourceVersion
  Long
  Monotonic version used by downstream sync.
  Example: 10
  status
  String
  Normalized resource status.
  Example: Enabled
  createdAt
  String
  Creation time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  updatedAt
  String
  Update time returned by ZIAM when available.
  Example: 2026-01-15T08:00:00Z
  userCount
  Long
  Count of direct user members in this project.
  Example: 1
  directUserCount
  Long
  Count of direct user members in this project.
  Example: 1
  groupCount
  Long
  Count of user groups in this project.
  Example: 1
  userGroupCount
  Long
  Count of user groups in this project.
  Example: 1
  joinedAt
  String
  Relationship join time when the resource is returned as a related project row.
  Example: 2026-01-15T08:00:00Z
  projectNames
  List
  Display aggregate of related project names.
  Example: item1,item2
  projectCount
  Long
  Display aggregate count of related projects.
  Example: 1
  userCount
  Long
  Display aggregate count of direct user members.
  Example: 1
  directUserCount
  Long
  Display aggregate count of direct user members.
  Example: 1
  userGroupCount
  Long
  Display aggregate count of user groups related to a project.
  Example: 1
  ownerUuid
  String
  Organization owner user uuid when configured.
  Example: 11111111111111111111111111111111
  ownerName
  String
  Organization owner display name resolved from ownerUuid when available.
  Example: Alice
  departmentPath
  String
  Organization tree display path from root to this department.
  Example: Company/Engineering
  departmentPathNames
  List
  Organization tree display path as separate names.
  Example: item1,item2
  totalUserCount
  Long
  Organization display aggregate. Direct members plus descendant organization members.
  Example: 10
  groupUuids
  List
  Optional user create field. The new user is added to these groups after creation. Use an array even when only one group is selected.
  Example: item1,item2
  projectUuids
  List
  Optional user create field. The new user is added to these projects after creation. Use an array even when only one project is selected.
  Example: item1,item2
  organizationUuids
  List
  Optional user create field. The new user is added to these organizations or departments after creation. Use an array even when only one organization is selected.
  Example: item1,item2
  departmentUuids
  List
  Alias of organizationUuids for department tree UI. Use an array even when only one department is selected.
  Example: item1,item2
  joinedAt
  String
  Relationship creation time for membership resources.
  Example: 2026-01-15T08:00:00Z
  deletionTimestamp
  String
  Soft-delete timestamp for deleted users.
  Example: 2026-01-15T08:00:00Z
  deletionPhase
  String
  Deletion phase for soft-deleted users.
  Example: SoftDeleted
  retentionUntil
  String
  End of soft-delete retention window for deleted users.
  Example: 2026-01-15T08:00:00Z
  finalizers
  List
  Deletion finalizers applied to soft-deleted users.
  Example: item1,item2

Request Example

curl -X POST '{host}/api/v1/ziam/resources/{collection}/batch' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "operation": "disable",
  "items": [
    {
      "uuid": "11111111111111111111111111111111",
      "data": {
        "uuid": "11111111111111111111111111111111",
        "name": "alice",
        "userName": "alice",
        "displayName": "Alice",
        "description": "A brief description",
        "password": "password123",
        "confirmPassword": "password123",
        "email": "alice@example.com",
        "phone": "+8613800138000",
        "phoneNumber": "+8613800138000",
        "mobile": "+8613800138000",
        "source": "ZIAM",
        "status": "Enabled",
        "credentialStatus": {
          "type": "password",
          "algorithm": "argon2id",
          "version": "1",
          "status": "Active",
          "mustChange": "false",
          "createdAt": "2026-06-17T01:00:00Z",
          "updatedAt": "2026-06-17T01:00:00Z"
        },
        "createdAt": "2026-06-16T10:00:00Z",
        "updatedAt": "2026-06-16T10:30:00Z",
        "lastLoginTime": "2026-06-16T10:00:00Z",
        "lastLoginIp": "172.26.53.126",
        "groups": [
          {
            "id": "group-001",
            "uuid": "group-001",
            "source": "ZIAM",
            "ziamGroupId": "group-001",
            "name": "Operators",
            "displayName": "Operators",
            "description": "A brief description",
            "projectId": "project-001",
            "projectUuid": "project-001",
            "enabled": "true",
            "active": "true",
            "members": [
              {
                "value": "11111111111111111111111111111111",
                "uuid": "11111111111111111111111111111111",
                "display": "Alice",
                "joinedAt": "2026-06-16T10:00:00Z"
              }
            ],
            "attributes": {},
            "resourceVersion": "10",
            "status": "Enabled",
            "createdAt": "2026-01-15T08:00:00Z",
            "updatedAt": "2026-01-15T08:00:00Z",
            "userCount": "1",
            "directUserCount": "1",
            "projects": [
              {
                "id": "project-001",
                "uuid": "project-001",
                "source": "ZIAM",
                "ziamProjectId": "project-001",
                "name": "Project A",
                "displayName": "Project A",
                "description": "A brief description",
                "organizationId": "dept-001",
                "organizationUuid": "dept-001",
                "tenantId": "tenant-001",
                "tenantUuid": "tenant-001",
                "accountId": "account-001",
                "accountUuid": "account-001",
                "linkAccountUuid": "account-001",
                "enabled": "true",
                "active": "true",
                "attributes": {},
                "resourceVersion": "10",
                "status": "Enabled",
                "createdAt": "2026-01-15T08:00:00Z",
                "updatedAt": "2026-01-15T08:00:00Z",
                "userCount": "1",
                "directUserCount": "1",
                "groupCount": "1",
                "userGroupCount": "1",
                "joinedAt": "2026-01-15T08:00:00Z"
              }
            ],
            "projectNames": [
              "{projectNames}"
            ],
            "projectCount": "1",
            "joinedAt": "2026-01-15T08:00:00Z"
          }
        ],
        "groupNames": [
          "{groupNames}"
        ],
        "groupCount": "1",
        "organizations": [
          {
            "id": "dept-001",
            "uuid": "dept-001",
            "source": "ZIAM",
            "ziamDepartmentId": "dept-001",
            "name": "Engineering",
            "displayName": "Engineering",
            "description": "A brief description",
            "parentId": "company-001",
            "parentUuid": "company-001",
            "rootId": "company-001",
            "rootUuid": "company-001",
            "type": "Department",
            "enabled": "true",
            "active": "true",
            "members": [
              {
                "value": "11111111111111111111111111111111",
                "uuid": "11111111111111111111111111111111",
                "display": "Alice",
                "joinedAt": "2026-06-16T10:00:00Z"
              }
            ],
            "attributes": {},
            "resourceVersion": "10",
            "status": "Enabled",
            "createdAt": "2026-01-15T08:00:00Z",
            "updatedAt": "2026-01-15T08:00:00Z",
            "ownerUuid": "11111111111111111111111111111111",
            "ownerName": "Alice",
            "departmentPath": "Company/Engineering",
            "departmentPathNames": [
              "{departmentPathNames}"
            ],
            "directUserCount": "1",
            "totalUserCount": "10",
            "joinedAt": "2026-01-15T08:00:00Z"
          }
        ],
        "directOrganizations": [
          {
            "id": "dept-001",
            "uuid": "dept-001",
            "source": "ZIAM",
            "ziamDepartmentId": "dept-001",
            "name": "Engineering",
            "displayName": "Engineering",
            "description": "A brief description",
            "parentId": "company-001",
            "parentUuid": "company-001",
            "rootId": "company-001",
            "rootUuid": "company-001",
            "type": "Department",
            "enabled": "true",
            "active": "true",
            "members": [
              {
                "value": "11111111111111111111111111111111",
                "uuid": "11111111111111111111111111111111",
                "display": "Alice",
                "joinedAt": "2026-06-16T10:00:00Z"
              }
            ],
            "attributes": {},
            "resourceVersion": "10",
            "status": "Enabled",
            "createdAt": "2026-01-15T08:00:00Z",
            "updatedAt": "2026-01-15T08:00:00Z",
            "ownerUuid": "11111111111111111111111111111111",
            "ownerName": "Alice",
            "departmentPath": "Company/Engineering",
            "departmentPathNames": [
              "{departmentPathNames}"
            ],
            "directUserCount": "1",
            "totalUserCount": "10",
            "joinedAt": "2026-01-15T08:00:00Z"
          }
        ],
        "organizationNames": [
          "{organizationNames}"
        ],
        "departmentNames": [
          "{departmentNames}"
        ],
        "directOrganizationCount": "1",
        "projects": [
          {
            "id": "project-001",
            "uuid": "project-001",
            "source": "ZIAM",
            "ziamProjectId": "project-001",
            "name": "Project A",
            "displayName": "Project A",
            "description": "A brief description",
            "organizationId": "dept-001",
            "organizationUuid": "dept-001",
            "tenantId": "tenant-001",
            "tenantUuid": "tenant-001",
            "accountId": "account-001",
            "accountUuid": "account-001",
            "linkAccountUuid": "account-001",
            "enabled": "true",
            "active": "true",
            "attributes": {},
            "resourceVersion": "10",
            "status": "Enabled",
            "createdAt": "2026-01-15T08:00:00Z",
            "updatedAt": "2026-01-15T08:00:00Z",
            "userCount": "1",
            "directUserCount": "1",
            "groupCount": "1",
            "userGroupCount": "1",
            "joinedAt": "2026-01-15T08:00:00Z"
          }
        ],
        "projectNames": [
          "{projectNames}"
        ],
        "projectCount": "1",
        "userCount": "1",
        "directUserCount": "1",
        "userGroupCount": "1",
        "ownerUuid": "11111111111111111111111111111111",
        "ownerName": "Alice",
        "departmentPath": "Company/Engineering",
        "departmentPathNames": [
          "{departmentPathNames}"
        ],
        "totalUserCount": "10",
        "groupUuids": [
          "{groupUuids}"
        ],
        "projectUuids": [
          "{projectUuids}"
        ],
        "organizationUuids": [
          "{organizationUuids}"
        ],
        "departmentUuids": [
          "{departmentUuids}"
        ],
        "joinedAt": "2026-01-15T08:00:00Z",
        "deletionTimestamp": "2026-01-15T08:00:00Z",
        "deletionPhase": "SoftDeleted",
        "retentionUntil": "2026-01-15T08:00:00Z",
        "finalizers": [
          "{finalizers}"
        ]
      },
      "lockedUntil": "2026-06-17T00:00:00Z"
    }
  ]
}'

Response Example

{
  "status": "ok",
  "data": {
    "operation": "disable",
    "atomic": false,
    "total": 2,
    "succeeded": 1,
    "failed": 1,
    "results": [
      {
        "index": 1,
        "uuid": "11111111111111111111111111111111",
        "status": "ok",
        "msg": "uuid is required",
        "data": {
          "uuid": "11111111111111111111111111111111",
          "name": "alice",
          "userName": "alice",
          "displayName": "Alice",
          "description": "A brief description",
          "password": "password123",
          "confirmPassword": "password123",
          "email": "alice@example.com"
        }
      }
    ]
  }
}

Agent Plugins

Agents

Assets

Metrics Catalog

Collects

Infrastructure Misc

Installer

Lifecycle

OTA Upgrade Plans

OTA Versions & Policies

Federation & SSO

Change Management

Resource Deletion

Lifecycle Upgrade

Scrape Collection

Monitoring Cache

Monitoring Query & Overview

Auto Remediation

Monitoring Misc

Grafana Integration

Grafana Dashboards

Logging

Profiling

Zaku

Alert Rules

Alert Templates

Alert Channels & Integrations

Alert Events

Alert Routing & Policies

On-Call

SLO

Health Check

Credentials

ZIAM

Security

ZMetis Audit

Platforms

Platform Federation

Platform Self-Monitor

Platform Health

Platform Misc

ZMetis Tasks

Auth Context

Request Inputs

Body Fields

Responses