swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector TenantEmailRegistration API
schemes:
- https
tags:
- name: TenantEmailRegistration
paths:
  /emails:activate:
    post:
      tags:
      - TenantEmailRegistration
      summary: Microsoft Azure Activates The Tenant And Email Combination Using The Activation Code Received
      description: Activates the email registration for current tenant
      operationId: microsoftAzureReceivedsharesActivatetenantemailregistration
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/api-version'
      - in: header
        name: repeatability-request-id
        description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.
        type: string
      - in: body
        name: tenantEmailRegistration
        description: The tenant email registration payload
        required: true
        schema:
          $ref: '#/definitions/TenantEmailRegistration'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/TenantEmailRegistration'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/PurviewShareError'
          headers:
            x-ms-error-code:
              description: The error code
              type: string
      x-ms-examples:
        ReceivedShares_ActivateTenantEmailRegistration:
          $ref: ./examples/ReceivedShares_ActivateTenantEmailRegistration.json
  /emails:register:
    post:
      tags:
      - TenantEmailRegistration
      summary: Microsoft Azure Registers The Tenant And Email Combination For Activation
      description: Register an email for the current tenant
      operationId: microsoftAzureReceivedsharesRegistertenantemailregistration
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/api-version'
      - in: header
        name: repeatability-request-id
        description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/TenantEmailRegistration'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/PurviewShareError'
          headers:
            x-ms-error-code:
              description: The error code
              type: string
      x-ms-examples:
        ReceivedShares_RegisterTenantEmailRegistration:
          $ref: ./examples/ReceivedShares_RegisterTenantEmailRegistration.json
definitions:
  PurviewShareError:
    description: The purview share error model.
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/PurviewShareErrorInfo'
  State:
    description: State of the resource
    enum:
    - Unknown
    - Succeeded
    - Creating
    - Deleting
    - Moving
    - Failed
    type: string
    x-ms-enum:
      name: State
      modelAsString: true
      values:
      - value: Unknown
        description: The state of the resource is 'Unknown'
        name: Unknown state
      - value: Succeeded
        description: The state of the resource is 'Succeeded'
        name: Succeeded state
      - value: Creating
        description: The state of the resource is 'Creating'
        name: Creating state
      - value: Deleting
        description: The state of the resource is 'Deleting'
        name: Deleting state
      - value: Moving
        description: The state of the resource is 'Moving'
        name: Moving state
      - value: Failed
        description: The state of the resource is 'Failed'
        name: Failed state
  ProxyResource:
    description: Base data transfer object implementation for proxy resources.
    type: object
    properties:
      id:
        description: The unique id of the resource.
        type: string
        readOnly: true
      type:
        description: Type of the resource.
        type: string
        readOnly: true
  TenantEmailRegistrationProperties:
    description: Tenant email registration property bag.
    required:
    - activationCode
    type: object
    properties:
      activationCode:
        description: Activation code for the registration.
        type: string
      activationExpiration:
        format: date-time
        description: Date of the activation expiration. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
        type: string
        readOnly: true
      email:
        description: The email to register.
        type: string
        readOnly: true
      registrationStatus:
        $ref: '#/definitions/TenantEmailRegistrationStatus'
        readOnly: true
      state:
        $ref: '#/definitions/State'
        readOnly: true
      tenantId:
        description: The tenant id to register.
        type: string
        readOnly: true
  TenantEmailRegistrationStatus:
    description: Defines the supported types for registration.
    enum:
    - ActivationPending
    - Activated
    - ActivationAttemptsExhausted
    type: string
    x-ms-enum:
      name: TenantEmailRegistrationStatus
      modelAsString: true
      values:
      - value: ActivationPending
        description: The tenant email registration is in pending state
        name: Activation pending
      - value: Activated
        description: The tenant email registration is complete and has been activated
        name: Activated
      - value: ActivationAttemptsExhausted
        description: The tenant email registration has exhausted the max attempts
        name: Activation attempts exhausted
  PurviewShareErrorInfo:
    description: The purview share error body model.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Code of the error
        type: string
      details:
        description: Nested details of the error model
        type: array
        items:
          $ref: '#/definitions/PurviewShareErrorInfo'
      message:
        description: Message of the error
        type: string
      target:
        description: Target of the error
        type: string
  TenantEmailRegistration:
    description: A tenant email registration data transfer object.
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      properties:
        $ref: '#/definitions/TenantEmailRegistrationProperties'
parameters:
  api-version:
    in: query
    name: api-version
    description: The api version to use
    required: true
    type: string
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'