curl --request GET \
--url https://app.hookie.ai/admin/api/sso/requests \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/sso/requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/sso/requests"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"eligible": true,
"plan": "free",
"request": {
"id": "sreq_6f1c0a7e2b8d4c1e9a3f5b7d0c2e4a6f",
"kinds": [
"sso"
],
"domains": [
"acme.com"
],
"note": "<string>",
"status": "pending",
"requested_at": "2023-11-07T05:31:56Z",
"decided_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"supersedes": "<string>"
},
"approved": {
"id": "sreq_6f1c0a7e2b8d4c1e9a3f5b7d0c2e4a6f",
"kinds": [
"sso"
],
"domains": [
"acme.com"
],
"note": "<string>",
"status": "pending",
"requested_at": "2023-11-07T05:31:56Z",
"decided_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"supersedes": "<string>"
},
"portal_intents": [
"sso"
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}Read the workspace's SSO / Directory Sync request
The workspace’s latest request for single sign-on or Directory Sync, or null, and whether its plan offers them (eligible: Team only). Owner and admin. Never available to connected agents or API keys. While a change is in review, request is the change and approved the request still in force.
curl --request GET \
--url https://app.hookie.ai/admin/api/sso/requests \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/sso/requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/sso/requests"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"eligible": true,
"plan": "free",
"request": {
"id": "sreq_6f1c0a7e2b8d4c1e9a3f5b7d0c2e4a6f",
"kinds": [
"sso"
],
"domains": [
"acme.com"
],
"note": "<string>",
"status": "pending",
"requested_at": "2023-11-07T05:31:56Z",
"decided_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"supersedes": "<string>"
},
"approved": {
"id": "sreq_6f1c0a7e2b8d4c1e9a3f5b7d0c2e4a6f",
"kinds": [
"sso"
],
"domains": [
"acme.com"
],
"note": "<string>",
"status": "pending",
"requested_at": "2023-11-07T05:31:56Z",
"decided_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"supersedes": "<string>"
},
"portal_intents": [
"sso"
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}Authorizations
The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.
Response
The latest request.
free, standard, team The latest request: the approved one, a change or a first request in review, or the last decided.
Show child attributes
Show child attributes
The approved request in force, if any. Differs from request while a change is in review.
Show child attributes
Show child attributes
The Admin Portal intents that can be opened at all in this deployment. Single sign-on (sso) is closed until Hookie's sign-in can start an SSO login, because an active SSO connection on a verified domain makes WorkOS refuse every other sign-in method for that domain; today this is ["dsync"].
sso, dsync