| # Licensed to the Apache Software Foundation (ASF) under one or more |
| # contributor license agreements. See the NOTICE file distributed with |
| # this work for additional information regarding copyright ownership. |
| # The ASF licenses this file to You 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. |
| --- |
| basePath: http://api.usergrid.com |
| swaggerVersion: 1.1-SHAPSHOT.121026 |
| apiVersion: "0.1" |
| apis: |
| |
| - path: /management/token |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_auth_password_get |
| summary: Get management access token |
| notes: Get the management access token. See the OAuth2 specification for details. |
| parameters: |
| |
| - 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: Organization not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: mgt_auth_password_post |
| summary: Get management access token |
| notes: Get the management access token. See the OAuth2 specification for details. |
| parameters: |
| |
| - 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: Organization not found |
| code: 404 |
| |
| - path: /management/authorize |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_authorize_get |
| summary: Authorize client |
| notes: Authorize the client. See the OAuth2 specification. |
| parameters: |
| |
| - 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: Organization not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: mgt_authorize_post |
| summary: Authorize client |
| notes: Authorize the client. See the OAuth2 specification. |
| parameters: |
| |
| - name: response_type |
| defaultValue: token |
| description: Response type |
| dataType: string |
| allowableValues: |
| values: |
| - token |
| - code |
| valueType: LIST |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: client_id |
| description: Client ID |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: redirect_uri |
| description: Redirect URI |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: post |
| |
| - name: scope |
| description: Access Token Scope |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: post |
| |
| - name: state |
| description: Client State |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: post |
| |
| - name: username |
| description: Username |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: post |
| |
| - name: password |
| description: Password |
| dataType: string |
| required: false |
| allowMultiple: false |
| paramType: post |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Organization not found |
| code: 404 |
| |
| - path: /management/orgs |
| description: Management |
| operations: |
| |
| - httpMethod: POST |
| nickname: mgt_org_json_post |
| summary: Create new organization |
| notes: Create new organization. See Usergrid documentation for JSON format of |
| body. |
| parameters: |
| |
| - name: json |
| description: Organization to post |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: body |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Organization not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: mgt_org_form_post |
| summary: Create new organization |
| notes: Create new organization using form post parameters. |
| parameters: |
| |
| - name: organization |
| description: Organization |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: username |
| description: Admin Username |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: name |
| description: Admin Name |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: email |
| description: Admin Email |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: password |
| description: Admin Password |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Organization not found |
| code: 404 |
| |
| - path: /management/orgs/{org_name_or_uuid} |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_org_get |
| summary: Find organization by name or UUID |
| notes: Returns the organization details |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Organization not found |
| code: 404 |
| |
| - path: /management/orgs/{org_name_or_uuid}/activate |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_org_activate_get |
| summary: Activates the organization |
| notes: Activates the organization from link provided in email notification. |
| parameters: |
| |
| - name: org_name_or_uuid |
| description: Organization 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 |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: User not found |
| code: 404 |
| |
| - path: /management/orgs/{org_name_or_uuid}/reactivate |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_org_reactivate_get |
| summary: Reactivates the organization |
| notes: Request organization reactivation. |
| parameters: |
| |
| - name: org_name_or_uuid |
| description: Organization name 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: /management/orgs/{org_name_or_uuid}/feed |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_org_feed_get |
| summary: Get organization activity feed |
| notes: Get organization activity feed. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization name 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: /management/orgs/{org_name_or_uuid}/credentials |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_org_credentials_get |
| summary: Get organization client credentials |
| notes: Get the organization client credentials. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization name 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 |
| |
| - httpMethod: POST |
| nickname: mgt_org_credentials_post |
| summary: Generate organization client credentials |
| notes: Generate new organization client credentials. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization name 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: /management/orgs/{org_name_or_uuid}/users |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_org_users_get |
| summary: Get admin users for organization |
| notes: Get admin users for organization. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization name 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 |
| |
| - httpMethod: POST |
| nickname: mgt_org_users_json_post |
| summary: Create new admin user for organization |
| notes: Create new admin user for organization using JSON payload. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: json |
| description: Admin user to create |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: body |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: User not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: mgt_org_users_form_post |
| summary: Create new admin user for organization |
| notes: Create new admin user for organization using form parameters. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: org_name_or_uuid |
| description: Organization name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: username |
| description: Admin Username |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: name |
| description: Admin Name |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: email |
| description: Admin Email |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: password |
| description: Admin Password |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: User not found |
| code: 404 |
| |
| - path: /management/orgs/{org_name_or_uuid}/users/{user_username_email_or_uuid} |
| description: Management |
| operations: |
| |
| - httpMethod: PUT |
| nickname: mgt_org_user_put |
| summary: Add admin users to organization |
| notes: Adds existing admin users for organization. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: user_username_email_or_uuid |
| description: Admin 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 |
| |
| - httpMethod: DELETE |
| nickname: mgt_org_user_delete |
| summary: Remove admin user from organization |
| notes: Remove an admin user from organization. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: user_username_email_or_uuid |
| description: Admin 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: /management/orgs/{org_name_or_uuid}/apps |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_org_apps_get |
| summary: Get apps for organization |
| notes: Get apps for organization. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization 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: mgt_org_apps_json_post |
| summary: Create new applicationfor organization |
| notes: Create new application for organization using JSON payload. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: json |
| description: Application to create |
| 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: mgt_org_apps_form_post |
| summary: Create new application for organization |
| notes: Create new application for organization using form parameters. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: org_name_or_uuid |
| description: Organization name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: name |
| description: Application Name |
| 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: /management/orgs/{org_name_or_uuid}/apps/{app_name_or_uuid} |
| description: Management |
| operations: |
| |
| - httpMethod: DELETE |
| nickname: mgt_org_app_delete |
| summary: Delete an application in an organization |
| notes: Delete an application in an organization. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: app_name_or_uuid |
| description: Application 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 |
| |
| - path: /management/orgs/{org_name_or_uuid}/apps/{app_name_or_uuid}/credentials |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_org_app_credentials_get |
| summary: Get application keys |
| notes: Get application keys. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: app_name_or_uuid |
| description: Application 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: mgt_org_app_credentials_post |
| summary: Generate application keys |
| notes: Generate application keys. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: app_name_or_uuid |
| description: Application 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 |
| |
| - path: /management/users |
| description: Management |
| operations: |
| |
| - httpMethod: POST |
| nickname: mgt_org_user_json_post |
| summary: Create new admin user |
| notes: Create new admin user. See Usergrid documentation for JSON format of body. |
| parameters: |
| |
| - name: json |
| description: Admin user to post |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: body |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Organization not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: mgt_org_user_form_post |
| summary: Create new organization |
| notes: Create new admin using form post parameters. |
| parameters: |
| |
| - name: username |
| description: Admin Username |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: name |
| description: Admin Name |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: email |
| description: Admin Email |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: password |
| description: Admin Password |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Organization not found |
| code: 404 |
| |
| - path: /management/users/resetpw |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_org_user_reset_password_get |
| summary: Initiate a user password reset |
| notes: Initiate a user password reset. Returns browser-viewable HTML page. |
| parameters: [] |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Organization not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: mgt_org_user_reset_password_form_post |
| summary: Complete a user password reset |
| notes: Complete a user password reset. Handles form POST response. |
| parameters: |
| |
| - name: email |
| description: Admin 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: Organization not found |
| code: 404 |
| |
| - path: /management/users/{user_username_email_or_uuid} |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_admin_user_get |
| summary: Returns the admin user details |
| notes: Returns the admin user details. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: user_username_email_or_uuid |
| description: Admin username, email or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Organization not found |
| code: 404 |
| |
| - httpMethod: PUT |
| nickname: mgt_admin_user_json_put |
| summary: Updates the admin user details |
| notes: Updates the admin user details. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: user_username_email_or_uuid |
| description: Admin username, email or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: json |
| description: Admin user details |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: body |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Organization not found |
| code: 404 |
| |
| - path: /management/users/{user_username_email_or_uuid}/activate |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_admin_user_activate_get |
| summary: Activates the admin user |
| notes: Activates the admin user from link provided in email notification. |
| parameters: |
| |
| - 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: Admin 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: /management/users/{user_username_email_or_uuid}/reactivate |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_admin_user_reactivate_get |
| summary: Reactivates the admin user |
| notes: Request admin user reactivation. |
| parameters: |
| |
| - name: user_username_email_or_uuid |
| description: Admin 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: /management/users/{user_username_email_or_uuid}/feed |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_admin_user_feed_get |
| summary: Get admin user activity feed |
| notes: Get admin user activity feed. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: user_username_email_or_uuid |
| description: Admin 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: /management/users/{user_username_email_or_uuid}/password |
| description: Management |
| operations: |
| |
| - httpMethod: PUT |
| nickname: mgt_admin_user_password_json_put |
| summary: Set admin user password |
| notes: Set admin user password. See Usergrid documentation for JSON format of |
| body. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: user_username_email_or_uuid |
| description: Admin 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: /management/users/{user_username_email_or_uuid}/resetpw |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_admin_user_reset_password_get |
| summary: Initiate a user password reset |
| notes: Initiate a user password reset. Returns browser-viewable HTML page. |
| parameters: |
| |
| - name: user_username_email_or_uuid |
| description: Admin username, email or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: Organization not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: mgt_admin_user_reset_password_form_post |
| summary: Complete a user password reset |
| notes: Complete a user password reset. Handles form POST response. |
| parameters: |
| |
| - name: user_username_email_or_uuid |
| description: Admin 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: Organization not found |
| code: 404 |
| |
| - path: /management/users/{user_username_email_or_uuid}/orgs |
| description: Management |
| operations: |
| |
| - httpMethod: GET |
| nickname: mgt_admin_user_orgs_get |
| summary: Get organizations for admin user |
| notes: Get organizations for admin user. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: user_username_email_or_uuid |
| description: Admin 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 |
| |
| - httpMethod: POST |
| nickname: mgt_admin_user_orgs_json_post |
| summary: Create new organization for admn user |
| notes: Create new organization for admin user using JSON payload. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: org_name_or_uuid |
| description: Organization name or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: json |
| description: Organization to create |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: body |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: User not found |
| code: 404 |
| |
| - httpMethod: POST |
| nickname: mgt_admin_user_orgs_form_post |
| summary: Create new organization for admin user |
| notes: Create new organization for admin user using form parameters. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| - name: user_username_email_or_uuid |
| description: Admin username, email or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: organization |
| description: Organization name |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: post |
| |
| responseTypeInternal: "" |
| responseClass: response |
| errorResponses: |
| - reason: Invalid ID supplied |
| code: 400 |
| - reason: User not found |
| code: 404 |
| |
| - path: /management/users/{user_username_email_or_uuid}/orgs/{org_name_or_uuid} |
| description: Management |
| operations: |
| |
| - httpMethod: PUT |
| nickname: mgt_admin_user_org_put |
| summary: Add admin user to organization |
| notes: Add admin users to organization. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: user_username_email_or_uuid |
| description: Admin user username, email, or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: org_name_or_uuid |
| description: Organization name 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 |
| |
| - httpMethod: DELETE |
| nickname: mgt_admin_user_org_delete |
| summary: Remove admin user from organization |
| notes: Remove an admin user from organization. |
| parameters: |
| |
| - name: access_token |
| description: The OAuth2 access token |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: query |
| |
| - name: user_username_email_or_uuid |
| description: Admin user username, email, or uuid |
| dataType: string |
| required: true |
| allowMultiple: false |
| paramType: path |
| |
| - name: org_name_or_uuid |
| description: Organization name 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 |
| |
| models: |
| response: |
| properties: |
| id: |
| type: long |
| name: |
| type: string |
| id: response |
| ... |
