Get pending invitation

Returns a pending invitation queued for an organization

Path Parameters

org_id string required
id string required

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

invitation object

id string

The unique invitation identifier.

user_id string

The user email of the invited user.

org_id string

The organization id to which the user is invited.

group_ids string[]

The list of group ids to which the user is invited.

metadata object

The metadata of the invitation.

created_at date-time

The time when the invitation was created.

expires_at date-time

The time when the invitation expires.

role_ids string[]

The list of role ids to which the user is invited in an organization.

{
  "invitation": {
    "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[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "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[]
Array [
@type string
]

{
  "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[]
Array [
@type string
]

{
  "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[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

GET /v1beta1/organizations/:org_id/invitations/:id

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL

http://127.0.0.1:7400

Security Scheme

BasicBearer

Username

Password

org_id — path required

id — path required

curl / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations/:id' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations/:id' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations/:id' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations/:id' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations/:id' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations/:id' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations/:id' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations/:id' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/invitations/:id' \
-H 'Accept: application/json'