Invite user
Invite users to an organization, if user is not registered on the platform, it will be notified. Invitations expire in 7 days
Path Parameters
unique id of the organization to which user is invited
Request Body required
user_id is email id of user who are invited inside the organization. If user is not registered on the platform, it will be notified
list of group ids to which user needs to be added as a member.
list of role ids to which user needs to be added as a member. Roles are binded at organization level by default.
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
Schema
invitations object[]
{
"invitations": [
{
"id": "k9c4f4e2-9b9a-4c1a-8f1a-2b9b9b9b9b9b",
"user_id": "john.doe@raystack.org",
"org_id": "b9c4f4e2-9b9a-4c1a-8f1a-2b9b9b9b9b9b",
"group_ids": "c9c4f4e2-9b9a-4c1a-8f1a-2b9b9b9b9b9b",
"metadata": {
"key": "value"
},
"created_at": "2023-06-07T05:39:56.961Z",
"expires_at": "2023-06-07T05:39:56.961Z",
"role_ids": "d9c4f4e2-9b9a-4c1a-8f1a-2b9b9b9b9b9b"
}
]
}
Bad Request - The request was malformed or contained invalid parameters.
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Forbidden - User does not have permission to access the resource
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Not Found - The requested resource was not found
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Internal Server Error. Returned when theres is something wrong with Frontier server.
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
POST /v1beta1/organizations/:org_id/invitations
Authorization
name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic
Request
Request
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"user_ids": [
"string"
],
"group_ids": [
"string"
],
"role_ids": [
"string"
]
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"user_ids": [
"string"
],
"group_ids": [
"string"
],
"role_ids": [
"string"
]
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"user_ids": [
"string"
],
"group_ids": [
"string"
],
"role_ids": [
"string"
]
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"user_ids": [
"string"
],
"group_ids": [
"string"
],
"role_ids": [
"string"
]
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"user_ids": [
"string"
],
"group_ids": [
"string"
],
"role_ids": [
"string"
]
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"user_ids": [
"string"
],
"group_ids": [
"string"
],
"role_ids": [
"string"
]
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"user_ids": [
"string"
],
"group_ids": [
"string"
],
"role_ids": [
"string"
]
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"user_ids": [
"string"
],
"group_ids": [
"string"
],
"role_ids": [
"string"
]
}'
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"user_ids": [
"string"
],
"group_ids": [
"string"
],
"role_ids": [
"string"
]
}'