Skip to content
Artbucket

The organization's single sign-on

GET
/api/v1/sso
curl --request GET \
  --url http://localhost:3000/api/v1/sso \
  --header 'Authorization: Bearer <token>'

Its OpenID Connect provider, or null, and the redirect URIs to register with the provider before setting it up: redirectUri for APP_URL, and in redirectUris one more for each domain the organization uses for the app, since signing in there comes back there. Never the client secret. Organization admin.

Scope: admin.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Single sign-on

Media typeapplication/json
object
data
required
Any of:
object
issuer
required
string
clientId
required
string
domain
required
string
verified
required

The domain is proved: its people sign in through the provider

boolean
required
required

Addresses at the domain sign in only through the provider, but for the organization’s admins

boolean
projectId
required

The project its people land in the first time, able to read; null for the organization’s oldest

string | null
record
required

What proves the domain: add this record at your DNS host

object
type
required
string
Allowed value: TXT
name
required
string
value
required
string
redirectUri
required

Register this with the provider as the app’s redirect URI

string format: uri
redirectUri
required
string format: uri
redirectUris
required
Array<string>
Example
{
  "data": {
    "record": {
      "type": "TXT"
    }
  }
}

default

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}