Domain Group Me API

openapi: 3.2.0
info:
  title: Domain Group Me API
  contact:
    name: Domain Developer Support
    email: api@domain.com.au
  termsOfService: https://developer.domain.com.au/docs/latest/support/terms
  version: '1.0'
  description: 'Operations tagged Me across 2 of this provider''s published API definitions: domain-group-openapi-latest.json, domain-group-openapi-v1.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.domain.com.au/
  description: Primary
- url: https://api.domain.com.au/sandbox/
  description: Sandbox
tags:
- name: Me
paths:
  /v1/me:
    get:
      tags:
      - Me
      summary: Retrieve information about the currently authorised request
      operationId: Me_Profile
      responses:
        '200':
          description: User information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me.V1.MyDetails'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
      - apikey: []
      - oauth2: []
      x-domain-optionalscopes: openid email
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: false
      x-domain-environment: Any
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
  /v1/me/agencies:
    get:
      tags:
      - Me
      summary: Retrieve list of agencies with which the current client is associated
      operationId: Me_GetMyAgencies
      responses:
        '200':
          description: Agency information
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Me.V1.AgencySummary'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
      - apikey: []
      - oauth2:
        - api_agencies_read
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: true
      x-domain-environment: Any
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
  /v1/me/providers:
    get:
      tags:
      - Me
      summary: Retrieve list of provider Ids with which the current client is associated
      operationId: Me_GetMyProviders
      responses:
        '200':
          description: Provider information
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Me.V1.ProviderSummary'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
      - apikey: []
      - oauth2:
        - api_listings_write
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: false
      x-domain-environment: Any
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
components:
  schemas:
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
      x-data-access-level-info:
        Basic:
        - '*'
        Detailed:
        - '*'
        Full:
        - '*'
    Me.V1.AgencySummary:
      type: object
      properties:
        id:
          type:
          - integer
          - 'null'
          format: int32
        name:
          type:
          - string
          - 'null'
        admin:
          type:
          - boolean
          - 'null'
          description: True if this user is an admin of this agency
      additionalProperties: false
      x-data-access-level-info:
        Basic:
        - Id
        - Name
        Detailed:
        - Id
        - Name
        Full:
        - Id
        - Name
        - Admin
    Me.V1.ProviderSummary:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Provider identifier - this will map to the username
        companyName:
          type:
          - string
          - 'null'
          description: Company name
        contactNameTechnical:
          type:
          - string
          - 'null'
          description: Contact person's name for technical related enquiries
        emailTechnical:
          type:
          - string
          - 'null'
          description: Email address to receive technical related emails
        phoneTechnical:
          type:
          - string
          - 'null'
          description: Phone to be contact for technical related enquiries
        contactNameBusiness:
          type:
          - string
          - 'null'
          description: Contact person's name for business related enquiries
        emailBusiness:
          type:
          - string
          - 'null'
          description: Email address to receive business related emails
        phoneBusiness:
          type:
          - string
          - 'null'
          description: Phone to be contact for business related enquiries
      additionalProperties: false
      description: Create provider response
      x-data-access-level-info:
        Basic:
        - '*'
        Detailed:
        - '*'
        Full:
        - '*'
    Me.V1.MyDetails:
      type: object
      properties:
        authenticated:
          type: boolean
          description: True if the current request was successfully authenticated
        clientId:
          type:
          - string
          - 'null'
          description: The Client ID or API Key used to authenticated this request
        subjectId:
          type:
          - string
          - 'null'
          description: A unique user id, only if this request is authenticated as a user context.
        subjectEmail:
          type:
          - string
          - 'null'
          description: The users email address if available
      additionalProperties: false
      x-data-access-level-info:
        Basic:
        - Authenticated
        - ClientId
        - SubjectId
        - SubjectEmail
        Detailed:
        - Authenticated
        - ClientId
        - SubjectId
        - SubjectEmail
        Full:
        - Authenticated
        - ClientId
        - SubjectId
        - SubjectEmail
  securitySchemes:
    apikey:
      type: apiKey
      description: API Key in Header
      name: x-api-key
      in: header
    oauth2:
      type: oauth2
      description: OAuth 2
      flows:
        clientCredentials:
          tokenUrl: https://auth.domain.com.au/v1/connect/token
          scopes:
            api_addresslocators_read: api_addresslocators_read
            api_agencies_read: api_agencies_read
            api_agencies_write: api_agencies_write
            api_authorities_write: api_authorities_write
            api_avm_read: api_avm_read
            api_campaignperformance_read: api_campaignperformance_read
            api_dataset_read: api_dataset_read
            api_demographics_read: api_demographics_read
            api_enquiries_read: api_enquiries_read
            api_enquiries_write: api_enquiries_write
            api_listingperformance_read: api_listingperformance_read
            api_listings_read: api_listings_read
            api_listings_write: api_listings_write
            api_locations_read: api_locations_read
            api_projectperformance_read: api_projectperformance_read
            api_properties_read: api_properties_read
            api_propertyportfolio_read: api_propertyportfolio_read
            api_propertyportfolio_write: api_propertyportfolio_write
            api_propertyreports_read: api_propertyreports_read
            api_salesresults_read: api_salesresults_read
            api_statistics_write: api_statistics_write
            api_suburbhistorical_read: api_suburbhistorical_read
            api_suburbperformance_read: api_suburbperformance_read
            api_suburbsummary_read: api_suburbsummary_read
            api_webhooks_write: api_webhooks_write
        authorizationCode:
          authorizationUrl: https://auth.domain.com.au/v1/connect/authorize
          tokenUrl: https://auth.domain.com.au/v1/connect/token
          refreshUrl: https://auth.domain.com.au/v1/connect/token
          scopes:
            api_addresslocators_read: api_addresslocators_read
            api_agencies_read: api_agencies_read
            api_agencies_write: api_agencies_write
            api_authorities_write: api_authorities_write
            api_avm_read: api_avm_read
            api_campaignperformance_read: api_campaignperformance_read
            api_dataset_read: api_dataset_read
            api_demographics_read: api_demographics_read
            api_enquiries_read: api_enquiries_read
            api_enquiries_write: api_enquiries_write
            api_listingperformance_read: api_listingperformance_read
            api_listings_read: api_listings_read
            api_listings_write: api_listings_write
            api_locations_read: api_locations_read
            api_projectperformance_read: api_projectperformance_read
            api_properties_read: api_properties_read
            api_propertyportfolio_read: api_propertyportfolio_read
            api_propertyportfolio_write: api_propertyportfolio_write
            api_propertyreports_read: api_propertyreports_read
            api_salesresults_read: api_salesresults_read
            api_statistics_write: api_statistics_write
            api_suburbhistorical_read: api_suburbhistorical_read
            api_suburbperformance_read: api_suburbperformance_read
            api_suburbsummary_read: api_suburbsummary_read
            api_webhooks_write: api_webhooks_write
x-refined-from:
- domain-group-openapi-latest.json
- domain-group-openapi-v1.json