schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
api.json | get | Get a single asset | {"tags": ["asset"], "operationId": "getAssetById", "responses": {"200": {}}} |
api.json | 200 | The asset that matches the given id. | {} |
api.json | delete | Remove an existing asset | {"tags": ["asset"], "operationId": "deleteAsset", "responses": {"204": {}}, "security": [{"studio": []}, {"app": ["resources:manage"]}]} |
api.json | 204 | The asset was successfully deleted. | {} |
api.json | post | Publish a block. | {"tags": ["block version"], "operationId": "publishBlock", "requestBody": {"content": {"multipart/form-data": {"schema": {}}}}, "responses": {"201": {}}, "security": [{"cli": ["blocks:write"]}]} |
api.json | requestBody | The new block version to publish. | {"content": {"multipart/form-data": {"schema": {}}}} |
api.json | get | Get all block’s latest definitions. | {"tags": ["block"], "operationId": "queryBlocks", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}, "security": [{"studio": []}, {}]} |
api.json | 200 | The list of all latest block versions. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | get | Get a single block | {"tags": ["block"], "operationId": "getBlock", "responses": {"200": {}}} |
api.json | 200 | The latest version of the block that matches the given id. | {} |
api.json | get | Retrieves all available versions of a block. | {"tags": ["block version"], "operationId": "getBlockVersions", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}} |
api.json | 200 | A list of versions of a block. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | get | Retrieve a single block version. | {"tags": ["block"], "operationId": "getBlockVersion", "responses": {"200": {}}} |
api.json | parameters | The file name of the block asset to download | {"name": "filename", "in": "query", "schema": {"type": "string"}} |
api.json | get | Download a single block asset | {"tags": ["block"], "operationId": "getBlockAsset", "responses": {"200": {}}} |
api.json | 200 | The asset that has been requested. | {} |
api.json | parameters | The language to get messages for. | {"in": "path", "name": "language", "schema": {"type": "string"}, "required": true} |
api.json | get | Get internationalized messages for a block. | {"tags": ["block"], "operationId": "getBlockMessages", "responses": {"200": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}}}} |
api.json | 200 | A key/value mapping of block messages. | {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"type": "string"}}}}} |
api.json | schema | A key/value mapping of block messages. | {"type": "object", "additionalProperties": {"type": "string"}} |
api.json | additionalProperties | A translated block message. | {"type": "string"} |
api.json | get | Get the icon of a block version. | {"tags": ["block"], "operationId": "getBlockIcon", "responses": {"200": {}}} |
api.json | 200 | The icon that represents the block. | {} |
api.json | post | Register a new account using an email address and a password. | {"tags": ["user"], "operationId": "registerEmail", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["email", "password"], "properties": {"name": {"type": "string"}, "email": {"type": "string", "format": "email"}, "password": {"type": "string", "minLength": 8},... |
api.json | requestBody | The user account to register. | {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["email", "password"], "properties": {"name": {"type": "string"}, "email": {"type": "string", "format": "email"}, "password": {"type": "string", "minLength": 8}, "timezone": {"enum": ["Africa/Abidjan", "Africa/Accra", "Africa/A... |
api.json | 201 | The account that was created. | {} |
api.json | post | Verify the email address of a registered user. | {"tags": ["user"], "operationId": "verifyEmail", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["token"], "properties": {"token": {"type": "string"}}}}}}, "responses": {"200": {}}} |
api.json | requestBody | The user account to register. | {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["token"], "properties": {"token": {"type": "string"}}}}}} |
api.json | 200 | The account was successfully verified. | {} |
api.json | post | Resend the verification code for a registered email. | {"tags": ["user"], "operationId": "resendEmailVerification", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["email"], "properties": {"email": {"type": "string", "format": "email"}}}}}}, "responses": {"204": {}}, "security": [{"studio": []}]} |
api.json | 204 | The verification email was sent if an account was found in the database. | {} |
api.json | post | Request a reset token for resetting passwords. | {"tags": ["user"], "operationId": "requestResetPassword", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["email"], "properties": {"email": {"type": "string", "format": "email"}}}}}}, "responses": {"204": {}}} |
api.json | 204 | The request has been received and an email was sent if it exists. | {} |
api.json | post | Reset a password using a password reset token. | {"tags": ["user"], "operationId": "resetPassword", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["password", "token"], "properties": {"password": {"type": "string", "minLength": 8}, "token": {"type": "string"}}}}}}, "responses": {"204": {}}} |
api.json | 204 | The password has been reset. | {} |
api.json | get | Check whether or not the API is healthy | {"tags": ["health"], "operationId": "checkHealth", "responses": {"200": {"content": {"application/json": {"schema": {}}}}}} |
api.json | 200 | An indication the server is healthy. | {"content": {"application/json": {"schema": {}}}} |
api.json | get | Check the SSL certificate status for the given domain names. | {"tags": ["health"], "operationId": "getSSLStatus", "parameters": [{"in": "query", "name": "domains", "required": true, "schema": {"type": "array", "items": {"type": "string", "format": "hostname"}}}], "responses": {"200": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"enum": [... |
api.json | 200 | A mapping of domain name to their SSL status | {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {"enum": ["error", "missing", "pending", "ready", "unknown"]}}}}} |
api.json | get | Get a list of timezones supported by the API | {"tags": ["health"], "operationId": "getTimezones", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "string"}}}}}}} |
api.json | 200 | A list of timezones supported by the API | {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "string"}}}}} |
api.json | parameters | The token of the invite. | {"name": "token", "in": "path", "required": true, "schema": {"type": "string"}} |
api.json | get | Fetch information about an invite. | {"tags": ["organization"], "operationId": "getInvitation", "responses": {"200": {}}} |
api.json | 200 | An invite response | {} |
api.json | post | Register new OAuth2 client credentials for the authenticated user. | {"tags": ["oauth2"], "operationId": "registerOAuth2ClientCredentials", "requestBody": {"required": true, "content": {"application/json": {"schema": {}}}}, "responses": {"201": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}]} |
api.json | requestBody | The OAuth2 client credentials | {"required": true, "content": {"application/json": {"schema": {}}}} |
api.json | 201 | The newly created client credentials | {"content": {"application/json": {"schema": {}}}} |
api.json | get | Get a list of client credentials for the authenticated user | {"tags": ["oauth2"], "operationId": "listOAuth2ClientCredentials", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}, "security": [{"studio": []}]} |
api.json | 200 | A list of client credentials entities. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | parameters | The client id of the OAuth2 client credentials on which to perform an operation | {"name": "clientId", "in": "path", "required": true, "schema": {"type": "string"}} |
api.json | delete | Revoke the client credentials | {"tags": ["oauth2"], "operationId": "deleteOAuth2ClientCredentials", "responses": {"204": {}}, "security": [{"studio": []}]} |
api.json | 204 | The client credentials have been revoked successfully. | {} |
api.json | post | asd | {"operationId": "registerOAuth2Connection", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["authorizationUrl", "code"], "properties": {"authorizationUrl": {"type": "string"}, "code": {"type": "string"}}}}}}, "responses": {"200": {}}} |
api.json | 200 | {} | |
api.json | post | Create an account using an OAuth2 authorization. | {"tags": ["oauth2"], "operationId": "connectPendingOAuth2Profile", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "additionalProperties": false, "required": ["code", "authorizationUrl", "timezone"], "properties": {"code": {"type": "string"}, "authorizationUrl": {"type": ... |
api.json | requestBody | The OAuth2 client credentials | {"required": true, "content": {"application/json": {"schema": {"type": "object", "additionalProperties": false, "required": ["code", "authorizationUrl", "timezone"], "properties": {"code": {"type": "string"}, "authorizationUrl": {"type": "string"}, "timezone": {"type": "string"}}}}}} |
api.json | 200 | An access token response. | {"content": {"application/json": {"schema": {"type": "object"}}}} |
api.json | get | Get a list of the user’s connected OAuth2 accounts. | {"tags": ["oauth2"], "operationId": "getConnectedAccounts", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"authorizationUrl": {"type": "string"}}}}}}}}, "security": [{"studio": []}]} |
api.json | 200 | An access token response. | {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"authorizationUrl": {"type": "string"}}}}}}} |
api.json | delete | Unlink a linked account from the logged in user. | {"tags": ["oauth2"], "operationId": "unlinkConnectedAccount", "parameters": [{"in": "query", "name": "authorizationUrl", "required": true, "schema": {"type": "string"}}], "responses": {"204": {}}, "security": [{"studio": []}]} |
api.json | 204 | The account was unlinked successfully. | {} |
api.json | get |
Get the user information formatted as OpenID user info.
See https://connect2id.com/products/server/docs/api/userinfo
| {"tags": ["openid", "user"], "operationId": "getUserInfo", "security": [{"studio": []}, {"app": ["openid"]}], "responses": {"200": {"content": {"application/json": {"schema": {"type": "object", "properties": {"sub": {"type": "string"}, "name": {"type": "string"}, "picture": {"type": "string", "format": "url"}, "email":... |
api.json | 200 | OpenID compatible user information | {"content": {"application/json": {"schema": {"type": "object", "properties": {"sub": {"type": "string"}, "name": {"type": "string"}, "picture": {"type": "string", "format": "url"}, "email": {"type": "string", "format": "email"}, "email_verified": {"type": "boolean"}}}}}} |
api.json | sub | The subject (end-user) identifier. | {"type": "string"} |
api.json | name | The full name of the end-user | {"type": "string"} |
api.json | picture | The URL of the profile page for the end-user. | {"type": "string", "format": "url"} |
api.json | email | The end-user’s preferred email address. | {"type": "string", "format": "email"} |
api.json | email_verified | True if the end-user’s email address has been verified, else false. | {"type": "boolean"} |
api.json | post | Verify if the user has previously agreed to the requested OAuth2 consent. | {"tags": ["oauth2"], "operationId": "verifyOAuth2Consent", "requestBody": {}, "responses": {"200": {}}, "security": [{"studio": []}]} |
api.json | post | Create a new OAuth2 consent. | {"tags": ["oauth2"], "operationId": "agreeOAuth2Consent", "requestBody": {}, "responses": {"201": {}}, "security": [{"studio": []}]} |
api.json | get | Fetch the list of organizations. | {"tags": ["organization"], "operationId": "getOrganizations", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}} |
api.json | 200 | The list of of organizations | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | post | Create a new organization. | {"tags": ["organization"], "operationId": "createOrganization", "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"id": {}, "name": {}, "email": {}, "website": {}, "icon": {"type": "string", "format": "binary"}}}, "encoding": {"icon": {"contentType": "imag... |
api.json | requestBody | The organization to create | {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"id": {}, "name": {}, "email": {}, "website": {}, "icon": {"type": "string", "format": "binary"}}}, "encoding": {"icon": {"contentType": "image/png,image/jpeg,image/tiff,image/webp"}}}}} |
api.json | icon | The organization icon. | {"type": "string", "format": "binary"} |
api.json | get | Get a single organization. | {"tags": ["organization"], "operationId": "getOrganization", "responses": {"200": {}}} |
api.json | patch | Update an organization | {"tags": ["organization"], "operationId": "patchOrganization", "requestBody": {"content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"name": {}, "email": {}, "website": {}, "icon": {"type": "string", "format": "binary"}}}, "encoding": {"icon": {"contentType": "image/png,image/jpeg,image/tiff,i... |
api.json | icon | The organization icon. | {"type": "string", "format": "binary"} |
api.json | get | Get the organization icon. | {"tags": ["organization"], "operationId": "getOrganizationIcon", "responses": {"200": {}}} |
api.json | 200 | The icon that represents the organization. | {} |
api.json | get | Get a list of organization members. | {"tags": ["organization"], "operationId": "getMembers", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}, "security": [{"studio": []}]} |
api.json | 200 | The list of all members. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | post | Request to resend an invitation. | {"tags": ["organization"], "operationId": "resendInvitation", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["email"], "properties": {"email": {"type": "string"}}}}}}, "responses": {"204": {}}, "security": [{"studio": []}]} |
api.json | requestBody | The email of the person to resend the invitation to. | {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["email"], "properties": {"email": {"type": "string"}}}}}} |
api.json | 204 | The invite has been sent. | {} |
api.json | post | Respond to a given invitation. | {"tags": ["organization"], "operationId": "respondInvitation", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["response", "token"], "properties": {"response": {"type": "boolean"}, "token": {"type": "string"}}}}}}, "responses": {"204": {}}, "security": [{"stu... |
api.json | requestBody | The response of the invitation.
If response is true, user will join the organization. If response is false, the user declines the invite and the invite is removed. | {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["response", "token"], "properties": {"response": {"type": "boolean"}, "token": {"type": "string"}}}}}} |
api.json | 204 | The response has been processed. | {} |
api.json | get | Get a list of invited organization members. | {"tags": ["organization"], "operationId": "getInvites", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"email": {"type": "string", "format": "email"}, "role": {"type": "string", "enum": ["Member", "Translator", "APIReader", "APIUser", "AppEd... |
api.json | 200 | The list of all invites. | {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"email": {"type": "string", "format": "email"}, "role": {"type": "string", "enum": ["Member", "Translator", "APIReader", "APIUser", "AppEditor", "Maintainer", "Owner"]}}}}}}} |
api.json | post | Invite a new member to the organization that matches the given id. | {"tags": ["organization"], "operationId": "inviteMembers", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "required": ["email", "role"], "properties": {"email": {"type": "string", "format": "email"}, "role": {"type": "string", "enum": ["Member"... |
api.json | requestBody | The member to invite. | {"required": true, "content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "required": ["email", "role"], "properties": {"email": {"type": "string", "format": "email"}, "role": {"type": "string", "enum": ["Member", "Translator", "APIReader", "APIUser", "AppEditor", "Maintainer", "Owner"... |
api.json | 201 | The newly invited member. | {"content": {"application/json": {"schema": {}}}} |
api.json | delete | Revoke a member invitation. | {"tags": ["organization"], "operationId": "removeInvite", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["email"], "properties": {"email": {"type": "string", "format": "email"}}}}}}, "responses": {"204": {}}, "security": [{"studio": []}]} |
api.json | requestBody | The email address to revoke the invite of. | {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["email"], "properties": {"email": {"type": "string", "format": "email"}}}}}} |
api.json | 204 | The invitation has been successfully revoked. | {} |
api.json | parameters | The ID of the member to remove | {"name": "memberId", "in": "path", "required": true, "schema": {}} |
api.json | delete | Remove a member from the organization that matches the given id, or leave the organization if the member id matches the user’s member id | {"tags": ["organization"], "operationId": "removeMember", "responses": {"204": {}}, "security": [{"studio": []}]} |
api.json | 204 | The member has been successfully removed. | {} |
api.json | parameters | The ID of the member | {"name": "memberId", "in": "path", "required": true, "schema": {}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.