Invite Harbor User

Beta

POST

https://app.polytomic.com/api/harbors/:harbor_id/users

Invites and assigns a new Harbor-only user.

The invited account is restricted to assigned Harbors and does not receive regular Polytomic application access.

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

harbor_idstringRequiredformat: "uuid"

Unique identifier of the Harbor.

This endpoint expects an object.

emailstringRequired

Email address used to invite the Harbor-only user.

dataobjectOptional

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X POST https://app.polytomic.com/api/harbors/248df4b7-aa70-47b8-a036-33ac447e668d/users \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"email": "analyst@example.com"
>	}'

1	{
2	"data": {
3	"created_at": "2024-01-15T09:30:00Z",
4	"email": "analyst@example.com",
5	"harbor_ids": [
6	"248df4b7-aa70-47b8-a036-33ac447e668d"
7	],
8	"harbor_only": true,
9	"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
10	"organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
11	"status": "invited"
12	}
13	}