Skip to content
KataraKatara documentation

Name the identity providers an organization signs in through

GET
/katara/v1/sign-in/organizations/{org_id}
curl --request GET \
  --url https://api.katara.com/katara/v1/sign-in/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Needs no session: the hosted sign-in page asks before anyone has signed in. Lists the upstream identity providers the organization’s enrolled connections broker through, which the page passes to the sign-in service as the provider hint. An organization without enterprise sign-in, or one that does not exist, answers an empty list. The hint carries no authority: the callback checks the enrolled connection, the subject’s mapping and current membership.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000

Responses

Section titled “Responses”

200

Section titled “200”

Successful request

Media typeapplication/json
object
org_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
connections
required
Array<object>
<= 128 items
object
upstream_id
required
string
>= 1 characters <= 256 characters /^[^\u0000-\u0020\u007f]+$/
Examplegenerated
{
  "org_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "connections": [
    {
      "upstream_id": "example"
    }
  ]
}

default

Section titled “default”

Request error

Media typeapplication/json
object
error
required
object
message
required
string
>= 1 characters <= 500 characters
type
required
string
>= 1 characters <= 100 characters
code
required

Stable; branch on it. Any operation can answer invalid_request, with param naming the refused field when there is one; human_session_required, when an API key, service account or workload calls an operation only a signed-in person may perform; reauthentication_required, when a person’s sign-in is too old for the operation; permission_denied; route_not_found and method_not_allowed, when no operation matches the path or method; and feature_unavailable, when the operation’s service is not enabled on this deployment.

string
>= 1 characters <= 100 characters
param
required

The request field a refusal is about, such as the agent_id or run_id query parameter; null when the refusal is not about one field.

string | null
request_id
required
string
>= 1 characters <= 100 characters
upstream_status
required
integer | null
action
Allowed values: sign_in reauthenticate request_access review fund retry reconcile refresh support
operation_id
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
snapshot_ref
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
Example
{
  "error": {
    "action": "sign_in"
  }
}