swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector GitHubOAuth API schemes: - https tags: - name: GitHubOAuth paths: /subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/githuboauth/default/getGitHubOAuthInfo: post: tags: - GitHubOAuth operationId: microsoftAzureGithuboauth summary: Microsoft Azure Gets Githuboauth Info Used To Authenticate Users With The Developer Hub Github App parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter - name: parameters required: false in: body schema: $ref: '#/definitions/GitHubOAuthCallRequest' responses: '200': description: OK schema: $ref: '#/definitions/GitHubOAuthInfoResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: GitHub OAuth: $ref: ./examples/GitHubOAuth.json description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/githuboauth/default: get: tags: - GitHubOAuth operationId: microsoftAzureGithuboauthcallback summary: Microsoft Azure Callback Url To Hit Once Authenticated With Github App To Have The Service Store The Oauth Token parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter - $ref: '#/parameters/GitHubOAuthCodeParameter' - $ref: '#/parameters/GitHubOAuthStateParameter' responses: '200': description: OK schema: $ref: '#/definitions/GitHubOAuthResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: GitHub OAuth Callback: $ref: ./examples/GitHubOAuthCallback.json description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/githuboauth: get: tags: - GitHubOAuth operationId: microsoftAzureListgithuboauth summary: Microsoft Azure Callback Url To Hit Once Authenticated With Github App To Have The Service Store The Oauth Token parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter responses: '200': description: OK schema: $ref: '#/definitions/GitHubOAuthListResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: List GitHub OAuth: $ref: ./examples/GitHubOAuth_List.json description: Needs a more full description created. definitions: GitHubOAuthInfoResponse: type: object description: URL used to authorize the Developer Hub GitHub App properties: authURL: type: string description: URL for authorizing the Developer Hub GitHub App token: type: string description: OAuth token used to make calls to GitHub GitHubOAuthProperties: type: object properties: username: type: string description: user making request description: The response from List GitHubOAuth operation. GitHubOAuthCallRequest: type: object properties: redirectUrl: type: string description: The URL the client will redirect to on successful authentication. If empty, no redirect will occur. description: GitHubOAuth request object GitHubOAuthResponse: type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource properties: properties: description: Properties of a workflow. $ref: '#/definitions/GitHubOAuthProperties' x-ms-client-flatten: true description: 'Singleton response of GitHubOAuth containing ' GitHubOAuthListResponse: type: object properties: value: type: array items: $ref: '#/definitions/GitHubOAuthResponse' description: Singleton list response containing one GitHubOAuthResponse response description: The response from List GitHubOAuth operation. parameters: GitHubOAuthCodeParameter: name: code in: query required: true type: string description: The code response from authenticating the GitHub App. x-ms-parameter-location: method GitHubOAuthStateParameter: name: state in: query required: true type: string description: The state response from authenticating the GitHub App. x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'