swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector OAuthTokens API
schemes:
- https
tags:
- name: OAuthTokens
paths:
  /oauth/tokens:
    get:
      tags:
      - OAuthTokens
      description: Returns a list of OAuthToken documents.
      operationId: microsoftAzureOauthtokensList
      produces:
      - application/json
      parameters:
      - in: query
        name: authProviderIds
        description: Name of AuthProvider.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: partyIds
        description: List of parties.
        type: array
        items:
          type: string
        collectionFormat: multi
      - in: query
        name: isValid
        description: If the token object is valid.
        type: boolean
      - in: query
        name: minCreatedDateTime
        description: Minimum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxCreatedDateTime
        description: Maximum creation date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: minLastModifiedDateTime
        description: Minimum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxLastModifiedDateTime
        description: Maximum last modified date of resource (inclusive).
        type: string
        format: date-time
      - in: query
        name: maxPageSize
        description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/OAuthTokenListResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        OAuthTokens_List:
          $ref: ./examples/OAuthTokens_List.json
      summary: Microsoft Azure Get Oauth Tokens
  /oauth/tokens/:connect:
    post:
      tags:
      - OAuthTokens
      description: Returns Connection link needed in the OAuth flow.
      operationId: microsoftAzureOauthtokensGetoauthconnectionlink
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: oauthConnectRequest
        description: OAuth Connect Request.
        required: true
        schema:
          $ref: '#/definitions/OAuthConnectRequest'
      responses:
        '200':
          description: Success
          schema:
            type: string
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        OAuthTokens_GetOAuthConnectionLink:
          $ref: ./examples/OAuthTokens_GetOAuthConnectionLink.json
      summary: Microsoft Azure Post Oauth Tokens :connect
  /oauth/tokens/remove/{jobId}:
    get:
      tags:
      - OAuthTokens
      description: Get remove job for OAuth token.
      operationId: microsoftAzureOauthtokensGetcascadedeletejobdetails
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Id of the job.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CascadeDeleteJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        OAuthTokens_GetCascadeDeleteJobDetails:
          $ref: ./examples/OAuthTokens_GetCascadeDeleteJobDetails.json
      summary: Microsoft Azure Get Oauth Tokens Remove Jobid
    put:
      tags:
      - OAuthTokens
      description: Create remove job for OAuth token.
      operationId: microsoftAzureOauthtokensCreatecascadedeletejob
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Job Id supplied by end user.
        required: true
        type: string
      - in: query
        name: partyId
        description: Id of the party.
        required: true
        type: string
      - in: query
        name: oauthProviderId
        description: Id of the OAuthProvider.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/CascadeDeleteJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        OAuthTokens_CreateCascadeDeleteJob:
          $ref: ./examples/OAuthTokens_CreateCascadeDeleteJob.json
      summary: Microsoft Azure Put Oauth Tokens Remove Jobid
definitions:
  ErrorResponse:
    description: An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
    type: object
    properties:
      error:
        $ref: '#/definitions/Error'
      traceId:
        description: Unique trace Id.
        type: string
  OAuthConnectRequest:
    description: Get OAuth config query parameters.
    required:
    - oAuthProviderId
    - partyId
    - userRedirectLink
    type: object
    properties:
      partyId:
        description: Id of the party.
        minLength: 1
        type: string
      oAuthProviderId:
        description: Id of the OAuthProvider.
        minLength: 1
        type: string
      userRedirectLink:
        description: Link to redirect the user to, at the end of the oauth flow.
        maxLength: 1000
        minLength: 0
        type: string
      userRedirectState:
        description: State to provide back when redirecting the user, at the end of the oauth flow.
        maxLength: 200
        minLength: 0
        type: string
  CascadeDeleteJob:
    description: Schema of cascade delete job.
    required:
    - partyId
    - resourceId
    - resourceType
    type: object
    properties:
      partyId:
        description: Party Id.
        minLength: 1
        type: string
      resourceId:
        description: The id of the resource.
        minLength: 1
        type: string
      resourceType:
        description: The type of the resource.
        minLength: 1
        type: string
      id:
        description: Unique job id.
        type: string
        readOnly: true
      status:
        description: "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'."
        enum:
        - Waiting
        - Running
        - Succeeded
        - Failed
        - Cancelled
        type: string
        readOnly: true
        x-ms-enum:
          name: JobStatus
          modelAsString: true
      durationInSeconds:
        format: double
        description: Duration of the job in seconds.
        type: number
        readOnly: true
      message:
        description: Status message to capture more details of the job.
        type: string
        readOnly: true
      errorCode:
        description: Error Code when job failed.
        type: string
        readOnly: true
      createdDateTime:
        format: date-time
        description: 'Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      lastActionDateTime:
        format: date-time
        description: 'Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      startTime:
        format: date-time
        description: 'Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
      endTime:
        format: date-time
        description: 'Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
  OAuthTokenListResponse:
    description: Paged response contains list of requested objects and a URL link to get the next set of results.
    required:
    - value
    type: object
    properties:
      value:
        description: List of requested objects.
        type: array
        items:
          $ref: '#/definitions/OAuthToken'
      skipToken:
        description: Token used in retrieving the next page. If null, there are no additional pages.
        type: string
      nextLink:
        description: Continuation link (absolute URI) to the next page of results in the list.
        type: string
  InnerError:
    description: Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
    type: object
    properties:
      code:
        description: Specific error code than was provided by the containing error.
        type: string
      innererror:
        $ref: '#/definitions/InnerError'
  Error:
    description: An error from the Azure AgPlatform service.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Server-defined set of error codes.
        minLength: 1
        type: string
      message:
        description: Human-readable representation of the error.
        minLength: 1
        type: string
      target:
        description: Target of the error.
        type: string
      details:
        description: Array of details about specific errors that led to this reported error.
        type: array
        items:
          $ref: '#/definitions/Error'
      innererror:
        $ref: '#/definitions/InnerError'
  OAuthToken:
    description: Schema of OAuth token resource.
    required:
    - authProviderId
    - partyId
    type: object
    properties:
      partyId:
        description: Party ID for this OAuth config.
        type: string
      authProviderId:
        description: ID of the OAuth provider resource containing app information.
        minLength: 1
        type: string
      isValid:
        description: 'An optional flag indicating whether the token is a valid or expired (Default value: true).'
        default: true
        type: boolean
      eTag:
        description: The ETag value to implement optimistic concurrency.
        type: string
        readOnly: true
      createdDateTime:
        format: date-time
        description: 'Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
      modifiedDateTime:
        format: date-time
        description: 'Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        readOnly: true
        example: '2020-12-31T11:10:21Z'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'