ZiamCreateResource
Creates a ZIAM resource. For users, phoneNumber/mobile are accepted aliases for phone, phone must be E.164, and groupUuids, projectUuids, organizationUuids, or departmentUuids may be included to create initial relationships after the user is created. These relationship fields must always be arrays; submit a one-element array for a single selected item.
/api/v1/ziam/resources/{collection}Operation ID
ZiamCreateResourceSince
1.0.0Execution Mode
SynchronousAuth Context
Auth RequiredAuth Context
Send these values as request headers when calling this API.
AuthorizationstringRequiredBearer Token
X-Tenant-IDstringX-Tenant-ID
Request Inputs
application/jsonBody Fields
uuidStringRequiredStable resource uuid. Generated when omitted for create.
Example: 11111111111111111111111111111111
nameStringRequiredCanonical resource name or user login name.
Example: alice
userNameStringRequiredAlias accepted for user login name. Normalized to name/userName for users.
Example: alice
displayNameStringRequiredDisplay name.
Example: Alice
descriptionStringRequiredBrief resource description shown on resource detail pages.
Example: A brief description
Responses
200 OKOn success, this API returns the following response structure.
statusStringStatus for this resource
Example: ok
dataObjectResponse payload data
uuidStringStable resource uuid. Generated when omitted for create.
Example: 11111111111111111111111111111111
nameStringCanonical resource name or user login name.
Example: alice
userNameStringAlias accepted for user login name. Normalized to name/userName for users.
Example: alice
displayNameStringDisplay name.
Example: Alice
descriptionStringBrief resource description shown on resource detail pages.
Example: A brief description
passwordStringUser password for create or password update. ZIAM hashes it into the internal credential and never returns it by list/detail APIs.
Example: password123
confirmPasswordStringOptional confirmation password. Must match password when present.
Example: password123
emailStringUser email. Must be unique when supplied.
Example: alice@example.com
phoneStringCanonical E.164 phone number.
Example: +8613800138000
phoneNumberStringAccepted alias for phone. ZIAM normalizes it to phone.
Example: +8613800138000
mobileStringAccepted alias for phone. ZIAM normalizes it to phone.
Example: +8613800138000
sourceStringIdentity data source. ZIAM-created resources use ZIAM.
Example: ZIAM
statusStringNormalized status such as Enabled, Disabled, Locked, or Deleted.
Example: Enabled
credentialStatusObjectCredential status for this resource
typeStringCredential type.
Example: password
algorithmStringPassword verifier algorithm used internally by ZIAM.
Example: argon2id
versionLongCredential schema or policy version.
Example: 1
statusStringCredential status.
Example: Active
mustChangeBooleanWhether the user must change the password on next login.
Example: false
createdAtStringCredential creation time.
Example: 2026-06-17T01:00:00Z
updatedAtStringLast credential update time.
Example: 2026-06-17T01:00:00Z
createdAtStringNormalized creation time returned by ZIAM when available.
Example: 2026-06-16T10:00:00Z
updatedAtStringNormalized update time returned by ZIAM when available.
Example: 2026-06-16T10:30:00Z
lastLoginTimeStringNormalized last login time returned for users when available.
Example: 2026-06-16T10:00:00Z
lastLoginIpStringNormalized last login IP returned for users when available.
Example: 172.26.53.126
groupsListUser list display aggregate. Groups related to the user.
Example: (nested array)
idStringStable ZIAM group id. Generated when omitted.
Example: group-001
uuidStringUnique identifier of this resource
Example: group-001
sourceStringSource for this resource
Example: ZIAM
ziamGroupIdStringZIAM group id exposed for Cloud detail pages.
Example: group-001
nameStringRequiredHuman-readable name of this resource
Example: Operators
displayNameStringDisplay name for this resource
Example: Operators
descriptionStringDescription for this resource
Example: A brief description
projectIdStringOptional project id that owns this group.
Example: project-001
projectUuidStringProject uuid for this resource
Example: project-001
enabledBooleanEnabled for this resource
Example: true
activeBooleanActive for this resource
Example: true
membersListMembers for this resource
Example: (nested array)
valueStringStable member uuid. ZIAM normalizes uuid into value.
Example: 11111111111111111111111111111111
uuidStringStable member uuid.
Example: 11111111111111111111111111111111
displayStringDisplay for this resource
Example: Alice
joinedAtStringTime when the user was added to this organization or group.
Example: 2026-06-16T10:00:00Z
attributesObjectAttributes for this resource
Example: (nested object)
resourceVersionLongMonotonic version used by downstream sync.
Example: 10
statusStringNormalized resource status.
Example: Enabled
createdAtStringCreation time returned by ZIAM when available.
Example: 2026-01-15T08:00:00Z
updatedAtStringUpdate time returned by ZIAM when available.
Example: 2026-01-15T08:00:00Z
userCountLongCount of direct user members.
Example: 1
directUserCountLongCount of direct user members.
Example: 1
projectsListProjects related to this group.
Example: (nested array)
idStringStable ZIAM project id. Generated when omitted.
Example: project-001
uuidStringUnique identifier of this resource
Example: project-001
sourceStringSource for this resource
Example: ZIAM
ziamProjectIdStringZIAM project id exposed for Cloud detail pages.
Example: project-001
nameStringRequiredHuman-readable name of this resource
Example: Project A
displayNameStringDisplay name for this resource
Example: Project A
descriptionStringDescription for this resource
Example: A brief description
organizationIdStringOrganization or department id this project belongs to.
Example: dept-001
organizationUuidStringOrganization uuid for this resource
Example: dept-001
tenantIdStringTenant or account id used by downstream products.
Example: tenant-001
tenantUuidStringTenant uuid for this resource
Example: tenant-001
accountIdStringOptional downstream account id.
Example: account-001
accountUuidStringAccount uuid for this resource
Example: account-001
linkAccountUuidStringOptional Cloud project linked account uuid.
Example: account-001
enabledBooleanEnabled for this resource
Example: true
activeBooleanActive for this resource
Example: true
attributesObjectAttributes for this resource
Example: (nested object)
resourceVersionLongMonotonic version used by downstream sync.
Example: 10
statusStringNormalized resource status.
Example: Enabled
createdAtStringCreation time returned by ZIAM when available.
Example: 2026-01-15T08:00:00Z
updatedAtStringUpdate time returned by ZIAM when available.
Example: 2026-01-15T08:00:00Z
userCountLongCount of direct user members in this project.
Example: 1
directUserCountLongCount of direct user members in this project.
Example: 1
groupCountLongCount of user groups in this project.
Example: 1
userGroupCountLongCount of user groups in this project.
Example: 1
joinedAtStringRelationship join time when the resource is returned as a related project row.
Example: 2026-01-15T08:00:00Z
projectNamesListNames of projects related to this group.
Example: item1,item2
projectCountLongCount of projects related to this group.
Example: 1
joinedAtStringRelationship join time when the resource is returned as a related group row.
Example: 2026-01-15T08:00:00Z
groupNamesListUser or group list display aggregate. Related group names.
Example: item1,item2
groupCountLongDisplay aggregate count of groups related to a project.
Example: 1
organizationsListUser list display aggregate. Direct organizations or departments related to the user.
Example: (nested array)
idStringStable ZIAM organization id. Generated when omitted.
Example: dept-001
uuidStringSame identity as id for downstream SCIM receivers.
Example: dept-001
sourceStringIdentity data source. ZIAM-created resources use ZIAM.
Example: ZIAM
ziamDepartmentIdStringZIAM department id exposed for Cloud detail pages.
Example: dept-001
nameStringRequiredHuman-readable name of this resource
Example: Engineering
displayNameStringDisplay name for this resource
Example: Engineering
descriptionStringDescription for this resource
Example: A brief description
parentIdStringParent organization id.
Example: company-001
parentUuidStringSame identity as parentId for downstream SCIM receivers.
Example: company-001
rootIdStringOptional root organization id.
Example: company-001
rootUuidStringRoot uuid for this resource
Example: company-001
typeStringCloud organization type. Defaults to Company for root nodes and Department when a parent is present.
Example: Department
enabledBooleanEnabled for this resource
Example: true
activeBooleanAlternative enabled flag accepted by SCIM receivers.
Example: true
membersListMembers for this resource
Example: (nested array)
valueStringStable member uuid. ZIAM normalizes uuid into value.
Example: 11111111111111111111111111111111
uuidStringStable member uuid.
Example: 11111111111111111111111111111111
displayStringDisplay for this resource
Example: Alice
joinedAtStringTime when the user was added to this organization or group.
Example: 2026-06-16T10:00:00Z
attributesObjectAttributes for this resource
Example: (nested object)
resourceVersionLongMonotonic version used by downstream sync.
Example: 10
statusStringNormalized resource status.
Example: Enabled
createdAtStringCreation time returned by ZIAM when available.
Example: 2026-01-15T08:00:00Z
updatedAtStringUpdate time returned by ZIAM when available.
Example: 2026-01-15T08:00:00Z
ownerUuidStringOrganization owner user uuid when configured.
Example: 11111111111111111111111111111111
ownerNameStringOrganization owner display name resolved by ZIAM when ownerUuid is available.
Example: Alice
departmentPathStringOrganization tree display path from root to this department.
Example: Company/Engineering
departmentPathNamesListOrganization tree display path as separate names.
Example: item1,item2
directUserCountLongCount of direct user members.
Example: 1
totalUserCountLongCount of direct members plus descendant organization members.
Example: 10
joinedAtStringRelationship join time when the resource is returned as a related organization row.
Example: 2026-01-15T08:00:00Z
directOrganizationsListUser list display aggregate. Direct department memberships.
Example: (nested array)
idStringStable ZIAM organization id. Generated when omitted.
Example: dept-001
uuidStringSame identity as id for downstream SCIM receivers.
Example: dept-001
sourceStringIdentity data source. ZIAM-created resources use ZIAM.
Example: ZIAM
ziamDepartmentIdStringZIAM department id exposed for Cloud detail pages.
Example: dept-001
nameStringRequiredHuman-readable name of this resource
Example: Engineering
displayNameStringDisplay name for this resource
Example: Engineering
descriptionStringDescription for this resource
Example: A brief description
parentIdStringParent organization id.
Example: company-001
parentUuidStringSame identity as parentId for downstream SCIM receivers.
Example: company-001
rootIdStringOptional root organization id.
Example: company-001
rootUuidStringRoot uuid for this resource
Example: company-001
typeStringCloud organization type. Defaults to Company for root nodes and Department when a parent is present.
Example: Department
enabledBooleanEnabled for this resource
Example: true
activeBooleanAlternative enabled flag accepted by SCIM receivers.
Example: true
membersListMembers for this resource
Example: (nested array)
valueStringStable member uuid. ZIAM normalizes uuid into value.
Example: 11111111111111111111111111111111
uuidStringStable member uuid.
Example: 11111111111111111111111111111111
displayStringDisplay for this resource
Example: Alice
joinedAtStringTime when the user was added to this organization or group.
Example: 2026-06-16T10:00:00Z
attributesObjectAttributes for this resource
Example: (nested object)
resourceVersionLongMonotonic version used by downstream sync.
Example: 10
statusStringNormalized resource status.
Example: Enabled
createdAtStringCreation time returned by ZIAM when available.
Example: 2026-01-15T08:00:00Z
updatedAtStringUpdate time returned by ZIAM when available.
Example: 2026-01-15T08:00:00Z
ownerUuidStringOrganization owner user uuid when configured.
Example: 11111111111111111111111111111111
ownerNameStringOrganization owner display name resolved by ZIAM when ownerUuid is available.
Example: Alice
departmentPathStringOrganization tree display path from root to this department.
Example: Company/Engineering
departmentPathNamesListOrganization tree display path as separate names.
Example: item1,item2
directUserCountLongCount of direct user members.
Example: 1
totalUserCountLongCount of direct members plus descendant organization members.
Example: 10
joinedAtStringRelationship join time when the resource is returned as a related organization row.
Example: 2026-01-15T08:00:00Z
organizationNamesListDisplay aggregate of related organization names.
Example: item1,item2
departmentNamesListDisplay aggregate of related department names.
Example: item1,item2
directOrganizationCountLongDisplay aggregate count of direct departments.
Example: 1
projectsListUser or group list display aggregate. Related projects.
Example: (nested array)
idStringStable ZIAM project id. Generated when omitted.
Example: project-001
uuidStringUnique identifier of this resource
Example: project-001
sourceStringSource for this resource
Example: ZIAM
ziamProjectIdStringZIAM project id exposed for Cloud detail pages.
Example: project-001
nameStringRequiredHuman-readable name of this resource
Example: Project A
displayNameStringDisplay name for this resource
Example: Project A
descriptionStringDescription for this resource
Example: A brief description
organizationIdStringOrganization or department id this project belongs to.
Example: dept-001
organizationUuidStringOrganization uuid for this resource
Example: dept-001
tenantIdStringTenant or account id used by downstream products.
Example: tenant-001
tenantUuidStringTenant uuid for this resource
Example: tenant-001
accountIdStringOptional downstream account id.
Example: account-001
accountUuidStringAccount uuid for this resource
Example: account-001
linkAccountUuidStringOptional Cloud project linked account uuid.
Example: account-001
enabledBooleanEnabled for this resource
Example: true
activeBooleanActive for this resource
Example: true
attributesObjectAttributes for this resource
Example: (nested object)
resourceVersionLongMonotonic version used by downstream sync.
Example: 10
statusStringNormalized resource status.
Example: Enabled
createdAtStringCreation time returned by ZIAM when available.
Example: 2026-01-15T08:00:00Z
updatedAtStringUpdate time returned by ZIAM when available.
Example: 2026-01-15T08:00:00Z
userCountLongCount of direct user members in this project.
Example: 1
directUserCountLongCount of direct user members in this project.
Example: 1
groupCountLongCount of user groups in this project.
Example: 1
userGroupCountLongCount of user groups in this project.
Example: 1
joinedAtStringRelationship join time when the resource is returned as a related project row.
Example: 2026-01-15T08:00:00Z
projectNamesListDisplay aggregate of related project names.
Example: item1,item2
projectCountLongDisplay aggregate count of related projects.
Example: 1
userCountLongDisplay aggregate count of direct user members.
Example: 1
directUserCountLongDisplay aggregate count of direct user members.
Example: 1
userGroupCountLongDisplay aggregate count of user groups related to a project.
Example: 1
ownerUuidStringOrganization owner user uuid when configured.
Example: 11111111111111111111111111111111
ownerNameStringOrganization owner display name resolved from ownerUuid when available.
Example: Alice
departmentPathStringOrganization tree display path from root to this department.
Example: Company/Engineering
departmentPathNamesListOrganization tree display path as separate names.
Example: item1,item2
totalUserCountLongOrganization display aggregate. Direct members plus descendant organization members.
Example: 10
groupUuidsListOptional 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
projectUuidsListOptional 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
organizationUuidsListOptional 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
departmentUuidsListAlias of organizationUuids for department tree UI. Use an array even when only one department is selected.
Example: item1,item2
joinedAtStringRelationship creation time for membership resources.
Example: 2026-01-15T08:00:00Z
deletionTimestampStringSoft-delete timestamp for deleted users.
Example: 2026-01-15T08:00:00Z
deletionPhaseStringDeletion phase for soft-deleted users.
Example: SoftDeleted
retentionUntilStringEnd of soft-delete retention window for deleted users.
Example: 2026-01-15T08:00:00Z
finalizersListDeletion finalizers applied to soft-deleted users.
Example: item1,item2
