Platform.sh User Profiles API

openapi: 3.2.0
info:
  title: Platform.sh User Profiles API
  version: '1.0'
  contact:
    name: Support
    url: https://upsun.com/contact-us/
  termsOfService: https://upsun.com/trust-center/legal/tos/
  x-logo:
    url: https://docs.upsun.com/images/upsun-api.svg
    href: https://upsun.com/#section/Introduction
    altText: Upsun logo
  description: 'Operations tagged User Profiles across 2 of this provider''s published API definitions: platform.sh-developer-portal-openapi-original.json, platform.sh-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: '{schemes}://api.upsun.com'
  description: The Upsun.com API gateway
  variables:
    schemes:
      default: https
tags:
- name: User Profiles
paths:
  /profiles:
    get:
      tags:
      - User Profiles
      summary: List user profiles
      operationId: list-profiles
      responses:
        '200':
          description: The list of user profiles.
          content:
            application/json:
              schema:
                properties:
                  count:
                    description: Total number of results.
                    type: integer
                  profiles:
                    description: Array of user profiles.
                    type: array
                    items:
                      $ref: '#/components/schemas/Profile'
                  _links:
                    $ref: '#/components/schemas/HalLinks'
                type: object
      security:
      - OAuth2: []
    servers:
    - url: '{schemes}://api.upsun.com'
      description: The Upsun.com API gateway
      variables:
        schemes:
          default: https
  /profiles/{userId}:
    get:
      tags:
      - User Profiles
      summary: Get a single user profile
      operationId: get-profile
      parameters:
      - $ref: '#/components/parameters/user_id'
      responses:
        '200':
          description: A User profile object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
      security:
      - OAuth2: []
    patch:
      tags:
      - User Profiles
      summary: Update a user profile
      description: Update a user profile, supplying one or more key/value pairs to to change.
      operationId: update-profile
      parameters:
      - $ref: '#/components/parameters/user_id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                display_name:
                  description: The user's display name.
                  type: string
                username:
                  description: The user's username.
                  type: string
                current_password:
                  description: The user's current password.
                  type: string
                password:
                  description: The user's new password.
                  type: string
                company_type:
                  description: The company type.
                  type: string
                company_name:
                  description: The name of the company.
                  type: string
                vat_number:
                  description: The vat number of the user.
                  type: string
                company_role:
                  description: The role of the user in the company.
                  type: string
                marketing:
                  description: Flag if the user agreed to receive marketing communication.
                  type: boolean
                ui_colorscheme:
                  description: The user's chosen color scheme for user interfaces. Available values are 'light' and 'dark'.
                  type: string
                default_catalog:
                  description: The URL of a catalog file which overrides the default.
                  type: string
                project_options_url:
                  description: The URL of an account-wide project options file.
                  type: string
                picture:
                  description: Url of the user's picture.
                  type: string
              type: object
      responses:
        '200':
          description: A User profile object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
      security:
      - OAuth2: []
    servers:
    - url: '{schemes}://api.upsun.com'
      description: The Upsun.com API gateway
      variables:
        schemes:
          default: https
  /profiles/{userId}/address:
    get:
      tags:
      - User Profiles
      summary: Get a user address
      operationId: get-address
      parameters:
      - $ref: '#/components/parameters/user_id'
      responses:
        '200':
          description: A user Address object extended with field metadata
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Address'
                - $ref: '#/components/schemas/AddressMetadata'
      security:
      - OAuth2: []
    patch:
      tags:
      - User Profiles
      summary: Update a user address
      description: Update a user address, supplying one or more key/value pairs to to change.
      operationId: update-address
      parameters:
      - $ref: '#/components/parameters/user_id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Address'
      responses:
        '200':
          description: A user Address object extended with field metadata.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Address'
                - $ref: '#/components/schemas/AddressMetadata'
      security:
      - OAuth2: []
    servers:
    - url: '{schemes}://api.upsun.com'
      description: The Upsun.com API gateway
      variables:
        schemes:
          default: https
  /profile/{uuid}/picture:
    post:
      tags:
      - User Profiles
      summary: Create a user profile picture
      operationId: create-profile-picture
      parameters:
      - name: uuid
        in: path
        description: The uuid of the user
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              properties:
                file:
                  description: The image file to upload.
                  type: string
                  format: binary
              type: object
      responses:
        '200':
          description: The new picture url.
          content:
            application/json:
              schema:
                properties:
                  url:
                    description: The relative url of the picture.
                    type: string
                type: object
      security:
      - OAuth2: []
    delete:
      tags:
      - User Profiles
      summary: Delete a user profile picture
      operationId: delete-profile-picture
      parameters:
      - name: uuid
        in: path
        description: The uuid of the user
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content success.
      security:
      - OAuth2: []
    servers:
    - url: '{schemes}://api.upsun.com'
      description: The Upsun.com API gateway
      variables:
        schemes:
          default: https
components:
  schemas:
    Profile:
      description: The user profile.
      properties:
        id:
          description: The user's unique ID.
          type: string
          format: uuid
        display_name:
          description: The user's display name.
          type: string
        email:
          description: The user's email address.
          type: string
          format: email
        username:
          description: The user's username.
          type: string
        type:
          description: The user's type (user/organization).
          type: string
          enum:
          - user
          - organization
        picture:
          description: The URL of the user's picture.
          type: string
          format: url
        company_type:
          description: The company type.
          type: string
        company_name:
          description: The name of the company.
          type: string
        currency:
          description: A 3-letter ISO 4217 currency code (assigned according to the billing address).
          type: string
        vat_number:
          description: The vat number of the user.
          type: string
        company_role:
          description: The role of the user in the company.
          type: string
        website_url:
          description: The user or company website.
          type: string
        new_ui:
          description: Whether the new UI features are enabled for this user.
          type: boolean
        ui_colorscheme:
          description: The user's chosen color scheme for user interfaces.
          type: string
        default_catalog:
          description: The URL of a catalog file which overrides the default.
          type: string
        project_options_url:
          description: The URL of an account-wide project options file.
          type: string
        marketing:
          description: Flag if the user agreed to receive marketing communication.
          type: boolean
        created_at:
          description: The timestamp representing when the user account was created.
          type: string
          format: date-time
        updated_at:
          description: The timestamp representing when the user account was last modified.
          type: string
          format: date-time
        billing_contact:
          description: The e-mail address of a contact to whom billing notices will be sent.
          type: string
          format: email
        current_trial:
          description: The current trial for the profile.
          properties:
            active:
              description: The trial active status.
              type: boolean
            created:
              description: The trial creation date.
              type: string
              format: date-time
            description:
              description: The trial description.
              type: string
            expiration:
              description: The trial expiration-date.
              type: string
              format: date-time
            current:
              description: The total amount spent by the trial user at this point in time.
              properties:
                formatted:
                  description: The total amount formatted.
                  type: string
                amount:
                  description: The total amount.
                  type: string
                currency:
                  description: The currency.
                  type: string
                currency_symbol:
                  description: Currency symbol.
                  type: string
              type: object
            spend:
              description: The total amount available for the trial.
              properties:
                formatted:
                  description: The total amount formatted.
                  type: string
                amount:
                  description: The total amount.
                  type: string
                currency:
                  description: The currency.
                  type: string
                currency_symbol:
                  description: Currency symbol.
                  type: string
              type: object
            spend_remaining:
              description: The remaining amount available for the trial.
              properties:
                formatted:
                  description: The total amount formatted.
                  type: string
                amount:
                  description: The total amount.
                  type: string
                currency:
                  description: The currency.
                  type: string
                currency_symbol:
                  description: Currency symbol.
                  type: string
                unlimited:
                  description: Spend limit is ignored (in favor of resource limitations).
                  type: boolean
              type: object
            projects:
              description: Projects active under trial
              properties:
                id:
                  description: Trial project ID
                  type: string
                name:
                  description: Trial project name
                  type: string
                total:
                  properties:
                    amount:
                      description: Trial project cost
                      type: integer
                    currency_code:
                      description: Currency code
                      type: string
                    currency_symbol:
                      description: Currency symbol
                      type: string
                    formatted:
                      description: Trial project cost formatted with currency sign
                      type: string
                  type: object
              type: object
            pending_verification:
              description: Required verification method (if applicable).
              type:
              - string
              - 'null'
              enum:
              - credit-card
              deprecated: true
            model:
              description: The trial trial model.
              type: string
            days_remaining:
              description: The amount of days until the trial expires.
              type: integer
          type: object
        invoiced:
          description: The customer is invoiced.
          type: boolean
      type: object
    HalLinks:
      description: Links to _self, and previous or next page, given that they exist.
      properties:
        self:
          description: The cardinal link to the self resource.
          properties:
            title:
              description: Title of the link
              type: string
            href:
              description: URL of the link
              type: string
          type: object
        previous:
          description: The link to the previous resource page, given that it exists.
          properties:
            title:
              description: Title of the link
              type: string
            href:
              description: URL of the link
              type: string
          type: object
        next:
          description: The link to the next resource page, given that it exists.
          properties:
            title:
              description: Title of the link
              type: string
            href:
              description: URL of the link
              type: string
          type: object
      type: object
    AddressMetadata:
      description: Information about fields required to express an address.
      properties:
        metadata:
          description: Address field metadata.
          properties:
            required_fields:
              description: Fields required to express the address.
              type: array
              items:
                type: string
            field_labels:
              description: Localized labels for address fields.
              type: object
            show_vat:
              description: Whether this country supports a VAT number.
              type: boolean
          type: object
      type: object
    Address:
      description: The address of the user.
      properties:
        country:
          description: Two-letter country codes are used to represent countries and states
          type: string
          format: ISO ALPHA-2
        name_line:
          description: The full name of the user
          type: string
        premise:
          description: Premise (i.e. Apt, Suite, Bldg.)
          type: string
        sub_premise:
          description: Sub Premise (i.e. Suite, Apartment, Floor, Unknown.
          type: string
        thoroughfare:
          description: The address of the user
          type: string
        administrative_area:
          description: The administrative area of the user address
          type: string
          format: ISO ALPHA-2
        sub_administrative_area:
          description: The sub-administrative area of the user address
          type: string
        locality:
          description: The locality of the user address
          type: string
        dependent_locality:
          description: The dependant_locality area of the user address
          type: string
        postal_code:
          description: The postal code area of the user address
          type: string
      type: object
    Profile_2:
      description: The user profile.
      properties:
        id:
          description: The user's unique ID.
          type: string
          format: uuid
        display_name:
          description: The user's display name.
          type: string
        email:
          description: The user's email address.
          type: string
          format: email
        username:
          description: The user's username.
          type: string
        type:
          description: The user's type (user/organization).
          type: string
          enum:
          - user
          - organization
        picture:
          description: The URL of the user's picture.
          type: string
          format: url
        company_type:
          description: The company type.
          type: string
        company_name:
          description: The name of the company.
          type: string
        currency:
          description: A 3-letter ISO 4217 currency code (assigned according to the billing address).
          type: string
        vat_number:
          description: The vat number of the user.
          type: string
        company_role:
          description: The role of the user in the company.
          type: string
        website_url:
          description: The user or company website.
          type: string
        new_ui:
          description: Whether the new UI features are enabled for this user.
          type: boolean
        ui_colorscheme:
          description: The user's chosen color scheme for user interfaces.
          type: string
        default_catalog:
          description: The URL of a catalog file which overrides the default.
          type: string
        project_options_url:
          description: The URL of an account-wide project options file.
          type: string
        marketing:
          description: Flag if the user agreed to receive marketing communication.
          type: boolean
        created_at:
          description: The timestamp representing when the user account was created.
          type: string
          format: date-time
        updated_at:
          description: The timestamp representing when the user account was last modified.
          type: string
          format: date-time
        billing_contact:
          description: The e-mail address of a contact to whom billing notices will be sent.
          type: string
          format: email
        invoiced:
          description: The customer is invoiced.
          type: boolean
        customer_type:
          description: The customer type.
          type: string
          enum:
          - individual
          - corporation
          - government
        legal_entity_name:
          description: The legal entity name of the customer.
          type: string
      type: object
  parameters:
    user_id:
      name: userId
      in: path
      description: The UUID of the user
      required: true
      schema:
        type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          tokenUrl: https://auth.api.platform.sh/oauth2/token
          refreshUrl: https://auth.api.platform.sh/oauth2/token
          scopes: {}
          authorizationUrl: https://auth.api.platform.sh/oauth2/authorize
      description: ''
    OAuth2Admin:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.api.platform.sh/oauth2/token
          refreshUrl: ''
          scopes:
            admin: administrative operations
      description: ''
    BearerAuth:
      type: http
      scheme: bearer
x-refined-from:
- platform.sh-developer-portal-openapi-original.json
- platform.sh-openapi-original.json
x-tagGroups:
- name: Organization Administration
  tags:
  - Organizations
  - Organization Members
  - Organization Invitations
  - Organization Projects
  - Add-ons
- name: Project Administration
  tags:
  - Project
  - Domain Management
  - Cert Management
  - Certificate Provisioner
  - Project Variables
  - Repository
  - Third-Party Integrations
  - Support
- name: Environments
  tags:
  - Environment
  - Environment Backups
  - Environment Type
  - Environment Variables
  - Routing
  - Source Operations
  - Runtime Operations
  - Deployment
  - Autoscaling
- name: User Activity
  tags:
  - Project Activity
  - Environment Activity
- name: Project Access
  tags:
  - Project Invitations
  - Teams
  - Team Access
  - User Access
- name: Account Management
  tags:
  - API Tokens
  - Connections
  - MFA
  - Users
  - User Profiles
  - SSH Keys
  - Plans
- name: Billing
  tags:
  - Organization Management
  - Subscriptions
  - Orders
  - Invoices
  - Discounts
  - Vouchers
  - Records
  - Profiles
- name: Global Info
  tags:
  - Project Discovery
  - References
  - Regions
- name: Internal APIs
  tags:
  - Project Settings
  - Environment Settings
  - Deployment Target
  - System Information
  - Container Profile
x-provenance:
  method: harvested
  publisher: Platform.sh
  source: https://developer.upsun.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)