{ "opencollection": "1.0.0", "info": { "name": "pryon/api/ext/analytics/v1/analytics.proto Organization Service API", "version": "1.0" }, "items": [ { "info": { "name": "OrganizationService", "type": "folder" }, "items": [ { "info": { "name": "CreateIdpDiscovery", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/access/v1/idp/discover", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ] }, "docs": "Anonymous can discover the Identity Provider associated with an email domain or user identified by email address." }, { "info": { "name": "ListIdentityProviders", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/idps", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ] }, "docs": "List the organization identity provider configuration" }, { "info": { "name": "ListIntegrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/integrations", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ] }, "docs": "ListIntegrations" }, { "info": { "name": "GetOrganization", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/org", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "org_id", "value": "", "type": "query" } ] }, "docs": "GetOrganization" }, { "info": { "name": "UpdateOrganization", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/access/v1/org", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ] }, "docs": "Use this API to update the following organization properties" }, { "info": { "name": "ListServices", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/services", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "authority", "value": "", "type": "query", "description": "Optional. Filter the response to only include services matching this authority." } ] }, "docs": "ListServices" }, { "info": { "name": "CreateService", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/access/v1/services", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "CreateService" }, { "info": { "name": "UpdateService", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/access/v1/services/:data.service_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "data.service_id", "value": "", "type": "path", "description": "A unique identifier for this service connect.\nRandomly generated uuid by server. Immutable after creation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "UpdateService" }, { "info": { "name": "GetService", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/services/:service_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "service_id", "value": "", "type": "path" } ] }, "docs": "GetService" }, { "info": { "name": "DeleteService", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/access/v1/services/:service_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "service_id", "value": "", "type": "path" } ] }, "docs": "DeleteService" }, { "info": { "name": "ListSolutions", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/solutions", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "page_size", "value": "", "type": "query", "description": "The number of items to be returned. Valid values are 1-100. Default is 100. The REST query parameter is \"page_size\"." }, { "name": "page_token", "value": "", "type": "query", "description": "If there are multiple pages, pages 2-N must specify this parameter using the value of next_page_token provided in the previous page's response. The REST query parameter is \"page_token\".\nsee https://cloud.google.com/apis/design/design_patterns#list_pagination." } ] }, "docs": "List all solutions configured for this organization" }, { "info": { "name": "GetSolution", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/solutions/:solution_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "solution_id", "value": "", "type": "path", "description": "Required. The solution id to retrieve." } ] }, "docs": "Retrieve existing solution by id" }, { "info": { "name": "ListTeams", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/teams", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ] }, "docs": "List an Organization's teams" }, { "info": { "name": "CreateTeam", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/access/v1/teams", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an empty team" }, { "info": { "name": "UpdateTeam", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/access/v1/teams/:data.team_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "data.team_id", "value": "", "type": "path", "description": "Required.\nA unique identifier for this team in UUID format.\nAssigned by server if not supplied during creation.\nImmutable after creation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a team's basic information" }, { "info": { "name": "GetTeam", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/teams/:team_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "team_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a team" }, { "info": { "name": "DeleteTeam", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/access/v1/teams/:team_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "team_id", "value": "", "type": "path" } ] }, "docs": "Delete a team including all its members" }, { "info": { "name": "ListTeamUsers", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/teams/:team_id/users", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "team_id", "value": "", "type": "path" } ] }, "docs": "List all the members of an existing team" }, { "info": { "name": "CreateTeamUser", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/access/v1/teams/:team_id/users", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "team_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a member to an existing team" }, { "info": { "name": "UpdateTeamUser", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/access/v1/teams/:team_id/users/:data.user_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The containing team's id" }, { "name": "data.user_id", "value": "", "type": "path", "description": "Required.\nMust correspond to a valid Org user capable of logging into the Pryon system\nImmutable after creation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing team member" }, { "info": { "name": "GetTeamUser", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/teams/:team_id/users/:user_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The containing team's id" }, { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a member of an existing team" }, { "info": { "name": "DeleteTeamUser", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/access/v1/teams/:team_id/users/:user_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The containing team's id" }, { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Delete a team member" }, { "info": { "name": "BatchCreateTeamUser", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/access/v1/teams/:team_id/users:batchCreate", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The containing team's id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add multiple members to an existing team via JSON data structure supplied in input" }, { "info": { "name": "BatchDeleteTeamUser", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/access/v1/teams/:team_id/users:batchDelete", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "team_id", "value": "", "type": "path", "description": "The containing team's id" } ] }, "docs": "Remove multiple team members via JSON data structure supplied in input" }, { "info": { "name": "GetUserInfo", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/user/current", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ] }, "docs": "A user authenticated with Pryon can request their authorization information.\nIf the Pryon platform cannot validate the user's access grant it will respond with HTTP Unauthorized status.\nIf the Pryon platform does not accept the user's access grant it will respond with HTTP Forbidden status." }, { "info": { "name": "ListUsers", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/users", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "status", "value": "", "type": "query", "description": "Filter list outputs to only include users that match this status. Defaults to UNSPECIFIED which disables this filter.\nThe REST query parameter is \"status\" and value can be the string or integer representation.\n\n - UNSPECIFIED: UNSPECIFIED: Default value that will never be used by the API as it is indistinguishable from unspecified status.\n - PENDING: PENDING: Waiting to be enabled by an organization admin.\nUseful to organization admins in gradually rolling out Pryon Platform access to organization users (e.g. bulk adding users and then enabling them in batches).\n - DISABLED_BY_ADMIN: DISABLED_BY_ADMIN: Administratively disabled by the organization admin (e.g. due to compromised credentials).\n - DISABLED_BY_SERVICE_OPERATOR: DISABLED_BY_SERVICE_OPERATOR: Disabled by a Pryon Service Operator (e.g. due to abuse).\nOnly a Pryon Service Operator can transition a user into and out of this state.\n - ACTIVE: ACTIVE: The user is in a functionally operational state" }, { "name": "type", "value": "", "type": "query", "description": "Filter list outputs to only include users of this type. Defaults to UNSPECIFIED which disables this filter.\nThe REST query parameter is \"type\" and value can be the string or integer representation.\n\n - UNSPECIFIED: UNSPECIFIED: Default value not used to characterize users internally.\n - HUMAN: HUMAN: A human user identified by a valid email address.\n - MACHINE: MACHINE: A machine user operating without human interaction and identified by its client id." }, { "name": "default_collection_id", "value": "", "type": "query", "description": "Filter list outputs to only include the users that use this knowledge collection as their default.\nThe REST questy parameter is \"default_collection_id\"." }, { "name": "page_size", "value": "", "type": "query", "description": "The number of items to be returned. Valid values are 1-100. Default is 100.\nREST query parameter is \"page_size\"." }, { "name": "page_token", "value": "", "type": "query", "description": "In case of multiple pages, pages 2-N must specify this parameter using the value of next_page_token provided in response for previous page.\nREST query parameter is \"page_token\".\nsee https://cloud.google.com/apis/design/design_patterns#list_pagination." } ] }, "docs": "List Organization Users" }, { "info": { "name": "CreateUser", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/access/v1/users", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a User" }, { "info": { "name": "UpdateUser", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/access/v1/users/:data.user_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "data.user_id", "value": "", "type": "path", "description": "Required on create and is immutable after creation.\nA unique identifier for this user within its Organization.\nThe id value is an email address for human users and a client id for machine users. On user create operations email addresses will automatically be converted to lower case, and this value will be reflected in the REST uris for such email identified users." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update User" }, { "info": { "name": "GetUser", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/access/v1/users/:user_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Get User by user_id" }, { "info": { "name": "BatchCreateUser", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/access/v1/users:batchCreate", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "BatchCreateUser adds multiple users to an organization and returns a list of users that were created." }, { "info": { "name": "BatchDeleteUser", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/access/v1/users:batchDelete", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ] }, "docs": "BatchDeleteUser removes multiple users from an organization." } ] } ], "bundled": true }