iam.invitations.createInvite someone to the organization
role `none` attaches no preset policy; `groupId` / `roleId` add the person to a group of this organization or give them a role when they accept.
Request syntax
POST /iam/api/invitations
{
"email": "string",
"role": "enum",
"groupId": "string",
"roleId": "string"
}Request body
emailRequiredstring
The address to invite; the invitation is mailed there
Constraints: email
roleOptionalenum
The organization role, and its preset policy, the person gets on accepting; none attaches no policy; default member
One of:
admin,member,viewer,billing,noneDefault:
"member"groupIdOptionalstring
A group of this organization the person joins on accepting
Constraints: uuid
roleIdOptionalstring
A role of this organization the person is given on accepting
Constraints: uuid
Response
201 with id, orgId, email, role, status, expiresAt (7 days on), createdAt, inviteUrl (the link to accept) and mailNotSent: why no mail was sent, or null when it was.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow iam:InviteUser on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud iam invitations create --email examplecurl -X POST "https://console.platform-development.deutschecloud.app/iam/api/invitations" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{"email":"example"}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_iam_invitations_create.