Get Connected App for Organization retrieves information about the specified Connected App as well as a list of the Organization's Members who have the App installed along with the scopes they requested at completion of their last authorization with the App.
Get a Connected App for an Organization
GET
https://test.stytch.com/v1/b2b/organizations/{organization_id}/connected_apps/{connected_app_id}Path parameters
organization_id* string
Globally unique UUID that identifies a specific Organization. The organization_id is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
connected_app_id* string
The ID of the Connected App.
Header parameters
X-Stytch-Member-Session string
The secret token for a Member Session that should be used to perform an authorization check for this endpoint. If neither session header is passed, no authorization check will be performed. If one is passed, we will check that the Member Session contains a Role that satisfies the permission needed to call this endpoint. If it does not, or if the Member's Organization does not match the organization_id passed in the request, a 403 error will be thrown. Otherwise, the request will proceed as normal.
X-Stytch-Member-SessionJWT string
The JSON Web Token (JWT) for a Member Session that should be used to perform an authorization check for this endpoint. If neither session header is passed, no authorization check will be performed. If one is passed, we will check that the Member Session contains a Role that satisfies the permission needed to call this endpoint. If it does not, or if the Member's Organization does not match the organization_id passed in the request, a 403 error will be thrown. Otherwise, the request will proceed as normal.
Response fields
request_id string
Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
connected_app_id string
The ID of the Connected App.
name string
The name of the Connected App.
description string
A description of the Connected App.
client_type string
The type of Connected App. Supported values are first_party, first_party_public, third_party, and third_party_public.
active_members array[objects]
Details about Members who has installed a Connected App.
member_id string
Globally unique UUID that identifies a specific Member.
granted_scopes array[string]
Scopes that were granted at the completion of the last authorization flow.
const stytch = require('stytch');
const client = new stytch.B2BClient({
project_id: 'PROJECT_ID',
secret: 'SECRET',
});
const params = {
organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
connected_app_id: "connected-app-test-d731954d-dab3-4a2b-bdee-07f3ad1be888",
};
const options = {
authorization: {
session_token: 'mZAYn5aLEqKUlZ_Ad9U_fWr38GaAQ1oFAhT8ds245v7Q',
},
};
client.organizations.getConnectedApp(params, options)
.then(resp => { console.log(resp) })
.catch(err => { console.log(err) });RESPONSE 200
200
{
"status_code": 200,
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"client_type": "third_party_public",
"connected_app_id": "${connectedAppId}",
"name": "Third Party Public",
"description": "Third Party Public App",
"logo_url": null,
"active_members": [
{
"member_id": "member-test-32fc5024-9c09-4da3-bd2e-c9ce4da9375f",
"granted_scopes": [
"openid",
"profile",
"email"
]
}
],
}RESPONSE 401
200
{
"status_code": 401,
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"error_type": "unauthorized_credentials",
"error_message": "Unauthorized credentials.",
"error_url": "https://stytch.com/docs/api/errors/401"
}RESPONSE 429
200
{
"status_code": 429,
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"error_type": "too_many_requests",
"error_message": "Too many requests have been made.",
"error_url": "https://stytch.com/docs/api/errors/429"
}RESPONSE 500
200
{
"status_code": 500,
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"error_type": "internal_server_error",
"error_message": "Oops, something seems to have gone wrong, please reach out to support@stytch.com to let us know what went wrong.",
"error_url": "https://stytch.com/docs/api/errors/500"
}