public
UserRole

Invites a user to an Organization with a specified role.

Changed on
post/orgs/{orgId}/invitations

Request

  • Base URL
    https://api.humanitec.io
  • URL
    https://api.humanitec.io/orgs/{orgId}/invitations
  • Auth
    none declared

Path parameters

orgIdstring required

The Organization ID

Request body

emailstring required

The email address of the user from the profile.

rolestring required

The role that this user would hold.

Example request

{
  "email": "jo.trigg@awesomecorp.com",
  "role": "manager"
}

Response

An temporary profile for the invited user.

created_atstring required

The time the user or the group was first registered with Humanitec

emailstring

The email address of the user from the profile

idstring required

The User or Group Id

invitestring

The status of an invitation (If applicable)

namestring required

The name the User or Group goes by

rolestring required

The role that this User or Group holds

typestring required

The type of the account. Could be user, service, group or system

idp_idstring

The IdP id the group is registered for. Empty if user is not a group.

Example response

[
  {
    "created_at": "2020-12-19T09:32:46Z",
    "email": "jo.trigg@awesomecorp.com",
    "id": "730c1f96-8ee5-4bff-8c22-898e0530b924",
    "invite": "accepted",
    "name": "Jo Trigg",
    "role": "manager",
    "type": "user"
  }
]

Changes

  • 4db6186594e3Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status