{"items":[{"type":"link","label":"Admin","link":"/admin","routeSlug":"/admin","content":{"contentType":"overview","meta":{"name":"Admin"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"admin.json","url":"/_bundle/admin.json?download"},{"kind":"download","label":"admin.yaml","url":"/_bundle/admin.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.blackbird.ai/admin"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Admin","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h2","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"An API Administering the Blackbird AI Platform."},"children":[]}]}]}],"sectionId":"/admin"}],"sectionId":"/admin"}]}]}},{"type":"group","label":"users","link":"/admin/users","routeSlug":"/admin/users","items":[{"label":"List all users in the organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/admin/users/getusers","routeSlug":"/admin/users/getusers","metadata":{"seo":{"title":"List all users in the organization","description":"Retrieves all users in the organization (Reconciliation endpoint). This endpoint allows organization administrators to reconcile their user list with internal identity management systems."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUsers","name":"List all users in the organization","isWebhook":false,"pointer":"/paths/~1admin~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all users in the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all users in the organization (Reconciliation endpoint). This endpoint allows organization administrators to reconcile their user list with internal identity management systems."},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.blackbird.ai/auth/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"email","in":"query","schemaId":"schema_48","description":"The email of the user to filter the list"}],"pointer":"/paths/~1admin~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admin/users","servers":[{"url":"https://api.blackbird.ai/admin"}],"parameters":{"path":[],"query":[{"name":"email","in":"query","required":false,"schemaId":"schema_48"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.blackbird.ai/auth/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/admin/users","href":"users/getusers","openApiOperationId":"getUsers","summary":"List all users in the organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.blackbird.ai/admin"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of users with their ID, email, active status, and relationships","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsersResponse"}},"schemaId":"components/schemas/UsersResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1admin~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UsersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsersResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getusers"}],"panels":[]}]},"httpPath":"/admin/users"},{"label":"Creates a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/admin/users/createuser","routeSlug":"/admin/users/createuser","metadata":{"seo":{"title":"Creates a user","description":"Creates a user with the given email and in the caller's organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUser","name":"Creates a user","isWebhook":false,"pointer":"/paths/~1admin~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a user with the given email and in the caller's organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.blackbird.ai/auth/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserCreateRequest"}},"schemaId":"components/schemas/UserCreateRequest","pointer":"/paths/~1admin~1users/post/requestBody","description":"A user to create"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/admin/users","servers":[{"url":"https://api.blackbird.ai/admin"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.blackbird.ai/auth/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserCreateRequest"}},"responseCodes":["200","400"],"pointer":"/admin/users","href":"users/createuser","openApiOperationId":"createUser","summary":"Creates a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.blackbird.ai/admin"}],"schemaId":"components/schemas/UserCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}},"schemaId":"components/schemas/UserResponse"},{"code":"400","description":"Invalid request body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}}],"pointer":"/paths/~1admin~1users/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}}},{"code":"400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/createuser"}],"panels":[]}]},"httpPath":"/admin/users"},{"label":"Get a specific user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/admin/users/getuserbyid","routeSlug":"/admin/users/getuserbyid","metadata":{"seo":{"title":"Get a specific user","description":"Retrieves a specific user by ID within the organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserById","name":"Get a specific user","isWebhook":false,"pointer":"/paths/~1admin~1users~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a specific user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific user by ID within the organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.blackbird.ai/auth/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_49","description":"The ID of the user to retrieve","required":true}],"pointer":"/paths/~1admin~1users~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admin/users/{id}","servers":[{"url":"https://api.blackbird.ai/admin"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.blackbird.ai/auth/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/admin/users/{id}","href":"users/getuserbyid","openApiOperationId":"getUserById","summary":"Get a specific user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.blackbird.ai/admin"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}},"schemaId":"components/schemas/UserResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1admin~1users~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuserbyid"}],"panels":[]}]},"httpPath":"/admin/users/{id}"},{"label":"Update a user's active status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/admin/users/updateuserstatus","routeSlug":"/admin/users/updateuserstatus","metadata":{"seo":{"title":"Update a user's active status","description":"Updates a user's active status using json-merge-patch format."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUserStatus","name":"Update a user's active status","isWebhook":false,"pointer":"/paths/~1admin~1users~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a user's active status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a user's active status using json-merge-patch format."},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.blackbird.ai/auth/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_49","description":"The ID of the user to update","required":true}],"pointer":"/paths/~1admin~1users~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserUpdateRequest"}},"schemaId":"components/schemas/UserUpdateRequest","pointer":"/paths/~1admin~1users~1{id}/put/requestBody","description":"Updating user's active status"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/admin/users/{id}","servers":[{"url":"https://api.blackbird.ai/admin"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_49"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.blackbird.ai/auth/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserUpdateRequest"}},"responseCodes":["200","400","404"],"pointer":"/admin/users/{id}","href":"users/updateuserstatus","openApiOperationId":"updateUserStatus","summary":"Update a user's active status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.blackbird.ai/admin"}],"schemaId":"components/schemas/UserUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}},"schemaId":"components/schemas/UserResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1admin~1users~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/updateuserstatus"}],"panels":[]}]},"httpPath":"/admin/users/{id}"},{"label":"Get available user roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/admin/users/getroles","routeSlug":"/admin/users/getroles","metadata":{"seo":{"title":"Get available user roles","description":"Retrieves a list of available user roles that can be assigned to users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRoles","name":"Get available user roles","isWebhook":false,"pointer":"/paths/~1admin~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get available user roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of available user roles that can be assigned to users."},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.blackbird.ai/auth/oauth2/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admin/roles","servers":[{"url":"https://api.blackbird.ai/admin"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.blackbird.ai/auth/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/admin/roles","href":"users/getroles","openApiOperationId":"getRoles","summary":"Get available user roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.blackbird.ai/admin"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of available roles","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RolesResponse"}},"schemaId":"components/schemas/RolesResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1admin~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RolesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RolesResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getroles"}],"panels":[]}]},"httpPath":"/admin/roles"},{"label":"Get app role mappings for the organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/admin/users/getapprolemappings","routeSlug":"/admin/users/getapprolemappings","metadata":{"seo":{"title":"Get app role mappings for the organization","description":"Retrieves IdP group to app role mappings for the authenticated organization. Requires superuser access. Superuser callers must pass organizationId as a query parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppRoleMappings","name":"Get app role mappings for the organization","isWebhook":false,"pointer":"/paths/~1admin~1role-mappings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get app role mappings for the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves IdP group to app role mappings for the authenticated organization. Requires superuser access. Superuser callers must pass organizationId as a query parameter."},{"nodeType":"security","requirements":[{"schemes":[{"name":"clientCredentials","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.blackbird.ai/auth/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"organizationId","in":"query","schemaId":"schema_50","description":"Organization id to fetch role mappings for. Required for superuser api-token callers."}],"pointer":"/paths/~1admin~1role-mappings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admin/role-mappings","servers":[{"url":"https://api.blackbird.ai/admin"}],"parameters":{"path":[],"query":[{"name":"organizationId","in":"query","required":false,"schemaId":"schema_50"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.blackbird.ai/auth/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","403"],"pointer":"/admin/role-mappings","href":"users/getapprolemappings","openApiOperationId":"getAppRoleMappings","summary":"Get app role mappings for the organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.blackbird.ai/admin"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of app role mappings","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppRoleMappingsResponse"}},"schemaId":"components/schemas/AppRoleMappingsResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1admin~1role-mappings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppRoleMappingsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppRoleMappingsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getapprolemappings"}],"panels":[]}]},"httpPath":"/admin/role-mappings"}],"content":{"contentType":"group","meta":{"name":"users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"users","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/admin/users","summary":"List all users in the organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getusers","deprecated":false},{"title":"/admin/users","summary":"Creates a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/createuser","deprecated":false},{"title":"/admin/users/{id}","summary":"Get a specific user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getuserbyid","deprecated":false},{"title":"/admin/users/{id}","summary":"Update a user's active status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/updateuserstatus","deprecated":false},{"title":"/admin/roles","summary":"Get available user roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getroles","deprecated":false},{"title":"/admin/role-mappings","summary":"Get app role mappings for the organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getapprolemappings","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Role":{"id":"components/schemas/Role","kind":"json-schema","title":"Role","data":{"type":"string","description":"The name of a user role. Note that there will be more values in the future and you should not consider a value outside the known enumeration as a breaking change, but the meaning of existing values will remain stable.","enum":["leadAnalyst"]}},"components/schemas/UserResource":{"id":"components/schemas/UserResource","kind":"json-schema","title":"UserResource","data":{"type":"object","required":["id","email","status","roles"],"properties":{"id":{"type":"string","description":"The resource ID"},"email":{"type":"string","format":"email","description":"The email address of the user"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"description":"The roles the user has"},"status":{"type":"string","description":"Whether the user is active or deactivated"},"firstName":{"type":"string","description":"The first name of the user"},"lastName":{"type":"string","description":"The last name of the user"}}}},"components/schemas/UsersResponse":{"id":"components/schemas/UsersResponse","kind":"json-schema","title":"UsersResponse","data":{"type":"object","description":"Response for collection of users (GET /users)","required":["body"],"properties":{"body":{"type":"array","description":"Array of user resources","items":{"$ref":"#/components/schemas/UserResource"}}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"error":{"type":"string","description":"The error message further explaining the error"}}}},"components/schemas/UserCreateRequest":{"id":"components/schemas/UserCreateRequest","kind":"json-schema","title":"UserCreateRequest","data":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","description":"The email address of the user"},"status":{"type":"string","description":"Whether the user is active or deactivated","default":"active","enum":["active","deactivated"]},"lastName":{"type":"string","description":"The last name of the user"},"firstName":{"type":"string","description":"The first names of the user"},"suppressWelcomeEmail":{"type":"boolean","description":"Prevents welcome email sending"},"appRootUrl":{"type":"string","description":"App root url to redirect users too. Not used when suppressWelcomeEmail is true."},"pageUrl":{"type":"string","description":"Page url to redirect users too. Not used when suppressWelcomeEmail is true.","default":"reset-password"}}}},"components/schemas/UserResponse":{"id":"components/schemas/UserResponse","kind":"json-schema","title":"UserResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response for a single user (GET /users/{id})"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/UserResource"}]}},"components/schemas/UserUpdateRequest":{"id":"components/schemas/UserUpdateRequest","kind":"json-schema","title":"UserUpdateRequest","data":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string","description":"The ID of the user to update"},"status":{"type":"string","description":"Whether the user is active or deactivated","enum":["active","deactivated"]},"lastName":{"type":"string","description":"The last name of the user"},"firstName":{"type":"string","description":"The first name of the user"}}}},"components/schemas/RoleResource":{"id":"components/schemas/RoleResource","kind":"json-schema","title":"RoleResource","data":{"type":"object","required":["roleName","displayName"],"properties":{"roleName":{"type":"string","description":"The unique identifier for the role"},"displayName":{"type":"string","description":"The human-readable display name for the role"}}}},"components/schemas/RolesResponse":{"id":"components/schemas/RolesResponse","kind":"json-schema","title":"RolesResponse","data":{"type":"object","description":"Response for collection of available roles (GET /admin/roles)","required":["body"],"properties":{"body":{"type":"array","description":"Array of role resources","items":{"$ref":"#/components/schemas/RoleResource"}}}}},"components/schemas/AppRoleMappingResource":{"id":"components/schemas/AppRoleMappingResource","kind":"json-schema","title":"AppRoleMappingResource","data":{"type":"object","required":["roleName","roleDisplayName","idpGroupNames","createdAt","updatedAt"],"properties":{"roleName":{"type":"string","description":"The app role name"},"roleDisplayName":{"type":"string","description":"The human-readable display name for the app role"},"idpGroupNames":{"type":"array","items":{"type":"string"},"description":"IdP group names mapped to this app role"},"createdAt":{"type":"string","format":"date-time","description":"When the mapping was created"},"updatedAt":{"type":"string","format":"date-time","description":"When the mapping was last updated"}}}},"components/schemas/AppRoleMappingsResponse":{"id":"components/schemas/AppRoleMappingsResponse","kind":"json-schema","title":"AppRoleMappingsResponse","data":{"type":"object","description":"Response for organization app role mappings (GET /admin/role-mappings)","required":["body"],"properties":{"body":{"type":"array","description":"Array of app role mapping resources","items":{"$ref":"#/components/schemas/AppRoleMappingResource"}}}}},"schema_48":{"kind":"json-schema","data":{"type":"string","format":"email"},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"string"},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_50"}},"exampleStore":{},"securitySchemeStore":{"clientCredentials":{"id":"clientCredentials","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.blackbird.ai/auth/oauth2/token","scopes":{}}}}},"servers":[{"url":"https://api.blackbird.ai/admin"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/admin","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/admin.json?download"},{"url":"/_bundle/admin.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Admin","description":"<h2>An API Administering the Blackbird AI Platform.</h2>"}},"baseSlug":"/admin","routesMapping":{}}