openapi: 3.2.0
info:
  title: Bynder Options API
  version: 1.0.0
  description: 'Operations tagged Options across 2 of this provider''s published API definitions: bynder-access-rights-and-options-v4-openapi.json, bynder-product-layer-v4-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{your-bynder-domain}/
  variables:
    your-bynder-domain:
      default: your-bynder-domainDefaultValue
- url: https://DefaultParameterValue
  variables: {}
- url: https://your-bynder-domainDefaultValue/v6/authentication/oauth2
  variables: {}
- url: https://{your-auth-url}
  variables:
    your-auth-url:
      default: DefaultParameterValue
tags:
- name: Options
  description: ''
paths:
  /api/1/content-access/options/{optionId}:
    get:
      summary: Retrieve Option Access Rights
      tags:
      - Options
      parameters:
      - name: optionId
        in: path
        required: true
        schema:
          type: string
        description: Option ID
      - name: principalId
        in: query
        required: false
        schema:
          type: string
        description: Principal ID
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 20
          minimum: 1
          maximum: 1000
        description: Number of results to return
      - name: start
        in: query
        required: false
        schema:
          type: string
        description: Cursor for next page
      - name: before
        in: query
        required: false
        schema:
          type: string
        description: Cursor for previous page
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiContentAccessMetapropertiesResponse'
        '403':
          description: Forbidden
      security:
      - OAuth2: []
      - permanentToken: []
    put:
      summary: Modify Option Access Rights
      tags:
      - Options
      parameters:
      - name: optionId
        in: path
        required: true
        schema:
          type: string
        description: Option ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiContentAccessMetapropertiesRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiContentAccessMetapropertiesResponse1'
        '403':
          description: Forbidden
      security:
      - OAuth2: []
      - permanentToken: []
    servers:
    - url: https://{your-bynder-domain}/
      variables:
        your-bynder-domain:
          default: your-bynder-domainDefaultValue
    - url: https://DefaultParameterValue
      variables: {}
    - url: https://your-bynder-domainDefaultValue/v6/authentication/oauth2
      variables: {}
    - url: https://{your-auth-url}
      variables:
        your-auth-url:
          default: DefaultParameterValue
    - url: https://DefaultParameterValue
      variables: {}
    - url: https://your-bynder-domainDefaultValue/v6/authentication/oauth2
      variables: {}
  /api/1/content-access/options/{optionId}/visibility:
    get:
      summary: Retrieve Option Default Visibility
      tags:
      - Options
      parameters:
      - name: optionId
        in: path
        required: true
        schema:
          type: string
        description: Option ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  defaultVisibility:
                    type: string
        '403':
          description: Forbidden
      security:
      - OAuth2: []
      - permanentToken: []
    put:
      summary: Modify Option Default Visibility
      tags:
      - Options
      parameters:
      - name: optionId
        in: path
        required: true
        schema:
          type: string
        description: Option ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                defaultVisibility:
                  type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  defaultVisibility:
                    type: string
        '403':
          description: Forbidden
      security:
      - OAuth2: []
      - permanentToken: []
    servers:
    - url: https://{your-bynder-domain}/
      variables:
        your-bynder-domain:
          default: your-bynder-domainDefaultValue
    - url: https://DefaultParameterValue
      variables: {}
    - url: https://your-bynder-domainDefaultValue/v6/authentication/oauth2
      variables: {}
    - url: https://{your-auth-url}
      variables:
        your-auth-url:
          default: DefaultParameterValue
    - url: https://DefaultParameterValue
      variables: {}
    - url: https://your-bynder-domainDefaultValue/v6/authentication/oauth2
      variables: {}
  /api/pim/metaproperties/{id}/options:
    get:
      summary: Retrieve metaproperty options
      description: Retrieve a paginated list of options for the given metaproperty id.
      tags:
      - Options
      security:
      - OAuth2:
        - METAPROPERTYMANAGEMENT
      - permanentToken:
        - METAPROPERTYMANAGEMENT
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 00000000-0000-0000-0000-0000000000000000
      - name: order
        in: query
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
          example: asc
      - name: page
        in: query
        required: false
        schema:
          type: integer
          example: 1
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          example: 20
      responses:
        '200':
          description: Successfully retrieved metaproperty options
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      example: 00000000-0000-0000-0000-000000000000
                    name:
                      type: string
                      example: Product A option 1
                    label:
                      type: string
                      example: Product A option 1
                    description:
                      type: string
                      example: Metaproperty option 1 for Product A
                    metapropertyid:
                      type: string
                      example: 00000000-0000-0000-0000-000000000000
                    product_options:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 00000000-0000-0000-0000-000000000000
                          name:
                            type: string
                            example: Product A option 1 child
                          label:
                            type: string
                            example: Product A option 1 child
                          description:
                            type: string
                            example: Metaproperty option 1 child
                          metapropertyid:
                            type: string
                            example: 00000000-0000-0000-0000-000000000000
    servers:
    - url: https://{your-bynder-domain}/
  /api/pim/metapropertyoptions/{id}:
    put:
      summary: Modify metaproperty option
      description: Edit the children of a metaproperty option.
      tags:
      - Options
      security:
      - OAuth2: []
      - permanentToken: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 00000000-0000-0000-0000-0000000000000000
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                children:
                  type: array
                  items:
                    type: string
                    example: 00000000-0000-0000-0000-000000000000
      responses:
        '204':
          description: Metaproperty option modified successfully
    servers:
    - url: https://{your-bynder-domain}/
components:
  schemas:
    PrincipalExtraInformation:
      title: PrincipalExtraInformation
      type: object
      properties:
        email:
          type: string
          examples:
          - user_email@bynder.com
    PrincipalType:
      title: PrincipalType
      enum:
      - user
      - group
      - profile
      type: string
      examples:
      - user
    ApiContentAccessMetapropertiesResponse1:
      title: ApiContentAccessMetapropertiesResponse1
      type: object
      properties:
        principalId:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000000
        principalType:
          type: string
          examples:
          - user
    Principal:
      title: Principal
      type: object
      properties:
        principalId:
          type: string
          examples:
          - 00000000-0000-0000-0000000000000000
        principalType:
          $ref: '#/components/schemas/PrincipalType'
    Level:
      title: Level
      const: metaproperty.hide
      type: string
      examples:
      - metaproperty.hide
    ApiContentAccessMetapropertiesRequest:
      title: ApiContentAccessMetapropertiesRequest
      type: object
      properties:
        principals:
          type: array
          items:
            $ref: '#/components/schemas/Principal'
          description: ''
        level:
          $ref: '#/components/schemas/Level'
    ApiContentAccessMetapropertiesResponse:
      title: ApiContentAccessMetapropertiesResponse
      type: object
      properties:
        id:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000000
        contentId:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000000
        contentType:
          type: string
          examples:
          - metaproperty
        level:
          type: string
          examples:
          - metaproperty.hide
        ruleType:
          type: string
          examples:
          - allow
        principalId:
          type: string
          examples:
          - 00000000-0000-0000-0000-000000000000
        principalType:
          type: string
          examples:
          - user
        principalName:
          type: string
          examples:
          - User full name
        principalExtraInformation:
          $ref: '#/components/schemas/PrincipalExtraInformation'
  securitySchemes:
    permanentToken:
      type: apiKey
      name: Authorization
      in: header
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token
          scopes: {}
        authorizationCode:
          authorizationUrl: https://DefaultParameterValue/
          tokenUrl: https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token
          scopes: {}
x-refined-from:
- bynder-access-rights-and-options-v4-openapi.json
- bynder-product-layer-v4-openapi.json