| # Licensed under the Apache License, Version 2.0 (the "License"); |
| # you may not use this file except in compliance with the License. |
| # You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. See accompanying LICENSE file. |
| --- |
| basePath: http://api.usergrid.com |
| swaggerVersion: 1.1-SHAPSHOT.121026 |
| apiVersion: "0.1" |
| apis: |
| |
| - path: /apps/{app_name_or_uuid}/token |
| description: Applications |
| operations: |
| |
| - httpMethod: GET |
| nickname: app_auth_password_get |
| summary: Get app access token |
| notes: Get the app access token. See the OAuth2 specification for details. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: grant_type |
| defaultValue: password |
| description: Grant type |
| dataType: string |
| allowableValues: |
| values: |
| - password |
| - client_credentials |
| - refresh_token |
| - authorization_code |
| valueType: LIST |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: username |
| description: Username (for grant_type=password) |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: password |
| description: Password (for grant_type=password) |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: client_id |
| description: Client ID (for grant_type=client_credentials) |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: client_secret |
| description: Client Secret (for grant_type=client_credentials) |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: app_auth_password_post |
| summary: Get app access token |
| notes: Get the app access token. See the OAuth2 specification for details. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: grant_type |
| defaultValue: password |
| description: Grant type |
| dataType: string |
| allowableValues: |
| values: |
| - password |
| - client_credentials |
| - refresh_token |
| - authorization_code |
| valueType: LIST |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: username |
| description: Username (for grant_type=password) |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: post |
| |
| - name: password |
| description: Password (for grant_type=password) |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: post |
| |
| - name: client_id |
| description: Client ID (for grant_type=client_credentials) |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: post |
| |
| - name: client_secret |
| description: Client Secret (for grant_type=client_credentials) |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: post |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - path: /apps/{app_name_or_uuid}/authorize |
| description: Applications |
| operations: |
| |
| - httpMethod: GET |
| nickname: app_authorize_get |
| summary: Authorize app client |
| notes: Authorize the app client. See the OAuth2 specification. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: response_type |
| defaultValue: token |
| description: Response type |
| dataType: string |
| allowableValues: |
| values: |
| - token |
| - code |
| valueType: LIST |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: client_id |
| description: Client ID |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: redirect_uri |
| description: Redirect URI |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: scope |
| description: Access Token Scope |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: state |
| description: Client State |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: app_authorize_post |
| summary: Authorize app client |
| notes: Authorize the app client. See the OAuth2 specification. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: response_type |
| defaultValue: token |
| description: Response type |
| dataType: string |
| allowableValues: |
| values: |
| - token |
| - code |
| valueType: LIST |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: client_id |
| description: Client ID |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: redirect_uri |
| description: Redirect URI |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: scope |
| description: Access Token Scope |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: state |
| description: Client State |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: username |
| description: Username |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: password |
| description: Password |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - path: /apps/{app_name_or_uuid}/credentials |
| description: Applications |
| operations: |
| |
| - httpMethod: GET |
| nickname: app_credentials_get |
| summary: Get app client credentials |
| notes: Get the app client credentials. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: User not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: app_credentials_post |
| summary: Generate app client credentials |
| notes: Generate new app client credentials. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: User not found |
| code: 404 |
| |
| - path: /apps/{app_name_or_uuid}/users |
| description: Applications |
| operations: |
| |
| - httpMethod: POST |
| nickname: app_user_json_post |
| summary: Create new app user |
| notes: Create new app user. See Usergrid documentation for JSON format of body. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: json |
| description: User to post |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: body |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: app_user_form_post |
| summary: Create new app user |
| notes: Create new app user using form post parameters. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: username |
| description: Username |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: name |
| description: User Full Name |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: email |
| description: User Email |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: password |
| description: User Password |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - path: /apps/{app_name_or_uuid}/users/resetpw |
| description: Applications |
| operations: |
| |
| - httpMethod: GET |
| nickname: app_users_reset_password_get |
| summary: Initiate a user password reset |
| notes: Initiate a user password reset. Returns browser-viewable HTML page. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: app_users_reset_password_form_post |
| summary: Complete a user password reset |
| notes: Complete a user password reset. Handles form POST response. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: email |
| description: User Email |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: recaptcha_challenge_field |
| description: Recaptcha Challenge Field |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: recaptcha_response_field |
| description: Recaptcha Response Field |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - path: /apps/{app_name_or_uuid}/users/{user_username_email_or_uuid} |
| description: Applications |
| operations: |
| |
| - httpMethod: GET |
| nickname: app_user_get |
| summary: Returns the app user details |
| notes: Returns the app user details. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: user_username_email_or_uuid |
| description: User username, email or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - httpMethod: PUT |
| nickname: app_user_json_put |
| summary: Updates the app user details |
| notes: Updates the app user details. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: user_username_email_or_uuid |
| description: User username, email or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: json |
| description: App user details |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: body |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - path: /apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/activate |
| description: Applications |
| operations: |
| |
| - httpMethod: GET |
| nickname: app_user_activate_get |
| summary: Activates the app user |
| notes: Activates the app user from link provided in email notification. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: token |
| description: Activation Token (supplied via email) |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: confirm |
| description: Send confirmation email |
| dataType: boolean |
| required: false |
| allowMultiple: false |
| paramType: path |
| |
| - name: user_username_email_or_uuid |
| description: User username, email or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: User not found |
| code: 404 |
| |
| - path: /apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/reactivate |
| description: Applications |
| operations: |
| |
| - httpMethod: GET |
| nickname: app_user_reactivate_get |
| summary: Reactivates the app user |
| notes: Request app user reactivation. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: user_username_email_or_uuid |
| description: User username, email or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: User not found |
| code: 404 |
| |
| - path: /apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/feed |
| description: Applications |
| operations: |
| |
| - httpMethod: GET |
| nickname: app_user_feed_get |
| summary: Get app user activity feed |
| notes: Get app user activity feed. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: user_username_email_or_uuid |
| description: User username, email or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: User not found |
| code: 404 |
| |
| - path: /apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/password |
| description: Applications |
| operations: |
| |
| - httpMethod: PUT |
| nickname: app_user_password_json_put |
| summary: Set app user password |
| notes: Set app user password. See Usergrid documentation for JSON format of body. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: user_username_email_or_uuid |
| description: User username, email or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: json |
| description: Old and new password |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: body |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: User not found |
| code: 404 |
| |
| - path: /apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/resetpw |
| description: Applications |
| operations: |
| |
| - httpMethod: GET |
| nickname: app_user_reset_password_get |
| summary: Initiate a user password reset |
| notes: Initiate a user password reset. Returns browser-viewable HTML page. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: user_username_email_or_uuid |
| description: User username, email or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: app_user_reset_password_form_post |
| summary: Complete a user password reset |
| notes: Complete a user password reset. Handles form POST response. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: user_username_email_or_uuid |
| description: User username, email or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: recaptcha_challenge_field |
| description: Recaptcha Challenge Field |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: recaptcha_response_field |
| description: Recaptcha Response Field |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - path: /apps/{app_name_or_uuid}/{collection} |
| description: Applications |
| operations: |
| |
| - httpMethod: GET |
| nickname: app_entity_get |
| summary: Query an app collection |
| notes: Query an app collection. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: collection |
| description: collection name (entity type) |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: ql |
| description: a query in the query language |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: reversed |
| description: return results in reverse order |
| dataType: boolean |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: start |
| description: the first entity UUID to return |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: cursor |
| description: an encoded representation of the query position for paging |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: limit |
| description: an encoded representation of the query position for paging |
| dataType: integer |
| required: false |
| allowMultiple: false |
| paramType: query |
| |
| - name: filter |
| description: a condition to filter on |
| dataType: integer |
| required: false |
| allowMultiple: true |
| paramType: query |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: app_entity_json_post |
| summary: Create new app entity |
| notes: Create new app entity. See Usergrid documentation for JSON format of body. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: collection |
| description: collection name (entity type) |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: json |
| description: User to post |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: body |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - path: /apps/{app_name_or_uuid}/{collection}/{entity_name_or_uuid} |
| description: Applications |
| operations: |
| |
| - httpMethod: PUT |
| nickname: app_entity_put |
| summary: Update an app entity |
| notes: Update an app entity in a collection. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: collection |
| description: collection name (entity type) |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: entity_name_or_uuid |
| description: entity name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: json |
| description: User to post |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: body |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| - httpMethod: DELETE |
| nickname: app_entity_delete |
| summary: Delete an app entity |
| notes: Delete an app entity. |
| parameters: |
| |
| - name: app_name_or_uuid |
| description: app name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: collection |
| description: collection name (entity type) |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: entity_name_or_uuid |
| description: entity name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Application not found |
| code: 404 |
| |
| models: |
| response: |
| properties: |
| id: |
| type: long |
| name: |
| type: string |
| id: response |
| ... |
