Invite a User

Invite User

post

Send an invite to user for your organization

Authorizations

Body

emailstringRequired

workspacesobject[]Required

rolestring · enumRequiredAvailable options:

workspace_api_key_detailsobjectOptional

Responses

application/json

objectOptionalExample: {"id":"a286286b-633d-4c4f-bddb-86b84a50a25c","invite_link":"https://app.portkey.ai/invite_id"}

post

DefaultDefaultDefaultSelf-HostedSelf-HostedSelf-Hosted

from portkey_ai import Portkey

# Initialize the Portkey client
portkey = Portkey(
    api_key="PORTKEY_API_KEY",
)

# Add a user invite
user = portkey.admin.users.invites.create(
    email="[e-mail]",
    role="member",
    workspaces=[
        {
            "id": "WORKSPACE_SLUG",
            "role": "admin"
        }
    ],
    workspace_api_key_details={
        "scopes": [
            "workspaces.list",
            "logs.export",
            "logs.list",
            "logs.view",
        ]
    }
)

print(user)

200

OK

{
  "id": "a286286b-633d-4c4f-bddb-86b84a50a25c",
  "invite_link": "https://app.portkey.ai/invite_id"
}