List user invitations
List all the invitations sent to a user.
Path Parameters
id string required
The user email to list the invitations for.
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
application/json
Schema
Example (from schema)
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.
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Forbidden - User does not have permission to access the resource
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Not Found - The requested resource was not found
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Internal Server Error. Returned when theres is something wrong with Frontier server.
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
application/json
Schema
Example (from schema)
Schema
code int32
message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
GET /v1beta1/users/:id/invitations
Authorization
name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic
Request
Request
curl / cURL
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/users/:id/invitations' \
-H 'Accept: application/json'
python / requests
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/users/:id/invitations' \
-H 'Accept: application/json'
go / native
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/users/:id/invitations' \
-H 'Accept: application/json'
nodejs / axios
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/users/:id/invitations' \
-H 'Accept: application/json'
ruby / Net::HTTP
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/users/:id/invitations' \
-H 'Accept: application/json'
csharp / RestSharp
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/users/:id/invitations' \
-H 'Accept: application/json'
php / cURL
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/users/:id/invitations' \
-H 'Accept: application/json'
java / OkHttp
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/users/:id/invitations' \
-H 'Accept: application/json'
powershell / RestMethod
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/users/:id/invitations' \
-H 'Accept: application/json'