C1 App Entitlement Owner API

openapi: 3.1.0
info:
  description: The ConductorOne API is a HTTP API for managing ConductorOne resources.
  title: ConductorOne Access Conflict App Entitlement Owner API
  version: 0.1.0-alpha
servers:
- description: The ConductorOne API server for the current tenant.
  url: https://{tenantDomain}.conductor.one
  variables:
    tenantDomain:
      default: example
      description: The domain of the tenant to use for this request.
security:
- bearerAuth: []
  oauth: []
tags:
- name: App Entitlement Owner
paths:
  /api/v1/apps/{app_id}/entitlements/{entitlement_id}/ownerids:
    get:
      description: ListUserIDs lists owner IDs for a given app entitlement.
      operationId: c1.api.app.v1.AppEntitlementOwners.ListOwnerIDs
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          description: The app_id field for the app entitlement to list owners of.
          readOnly: false
          type: string
      - in: path
        name: entitlement_id
        required: true
        schema:
          description: The entitlement_id field for the app entitlement to list owners of.
          readOnly: false
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.app.v1.ListAppEntitlementOwnerIDsResponse'
          description: The response message for listing app entitlement owners IDs.
      summary: List Owner I Ds
      tags:
      - App Entitlement Owner
      x-speakeasy-entity-operation:
        terraform-datasource: null
        terraform-resource: App_Entitlement_Owner#read
      x-speakeasy-group: AppEntitlementOwners
      x-speakeasy-name-override: ListOwnerIDs
  /api/v1/apps/{app_id}/entitlements/{entitlement_id}/owners:
    delete:
      description: Delete deletes the owners from a given app entitlement.
      operationId: c1.api.app.v1.AppEntitlementOwners.Delete
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          description: The app_id field for the app entitlement to remove the owner of.
          readOnly: false
          type: string
      - in: path
        name: entitlement_id
        required: true
        schema:
          description: The entitlement_id field for the app entitlement to remove the owner of.
          readOnly: false
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.app.v1.DeleteAppEntitlementOwnersRequestInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.app.v1.DeleteAppEntitlementOwnersResponse'
          description: the empty response message for deleting app entitlement owners.
      summary: Delete
      tags:
      - App Entitlement Owner
      x-speakeasy-entity-operation:
        terraform-resource: App_Entitlement_Owner#delete
      x-speakeasy-group: AppEntitlementOwners
      x-speakeasy-name-override: Delete
    get:
      description: List owners for a given app entitlement.
      operationId: c1.api.app.v1.AppEntitlementOwners.List
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          description: The app_id field for the app entitlement to list owners of.
          readOnly: false
          type: string
      - in: path
        name: entitlement_id
        required: true
        schema:
          description: The entitlement_id field for the app entitlement to list owners of.
          readOnly: false
          type: string
      - in: query
        name: page_size
        schema:
          description: The page_size field for pagination.
          format: int32
          readOnly: false
          type: integer
      - in: query
        name: page_token
        schema:
          description: The page_token field for pagination.
          readOnly: false
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.app.v1.ListAppEntitlementOwnersResponse'
          description: The response message for listing app entitlement owners.
      summary: List
      tags:
      - App Entitlement Owner
      x-speakeasy-group: AppEntitlementOwners
      x-speakeasy-name-override: List
    post:
      description: Add an owner to a given app entitlement.
      operationId: c1.api.app.v1.AppEntitlementOwners.Add
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          description: The app_id field for the app entitlement to add the owner to.
          readOnly: false
          type: string
      - in: path
        name: entitlement_id
        required: true
        schema:
          description: The entitlement_id field for the app entitlement to add the owner to.
          readOnly: false
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.app.v1.AddAppEntitlementOwnerRequestInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.app.v1.AddAppEntitlementOwnerResponse'
          description: The empty response message for adding an app entitlement owner.
      summary: Add
      tags:
      - App Entitlement Owner
      x-speakeasy-group: AppEntitlementOwners
      x-speakeasy-name-override: Add
    put:
      description: Sets the owners for a given app entitlement to the specified list of users.
      operationId: c1.api.app.v1.AppEntitlementOwners.Set
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          description: The app_id field for the app entitlement to set the owners of.
          readOnly: false
          type: string
      - in: path
        name: entitlement_id
        required: true
        schema:
          description: The entitlement_id field for the app entitlement to set the owners of.
          readOnly: false
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.app.v1.SetAppEntitlementOwnersRequestInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.app.v1.SetAppEntitlementOwnersResponse'
          description: The empty response message for setting the app entitlement owners.
      summary: Set
      tags:
      - App Entitlement Owner
      x-speakeasy-entity-operation:
        terraform-resource: App_Entitlement_Owner#create
      x-speakeasy-group: AppEntitlementOwners
      x-speakeasy-name-override: Set
  /api/v1/apps/{app_id}/entitlements/{entitlement_id}/owners/{user_id}:
    delete:
      description: Remove an owner from a given app entitlement.
      operationId: c1.api.app.v1.AppEntitlementOwners.Remove
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          description: The app_id field for the app entitlement to remove the owner of.
          readOnly: false
          type: string
      - in: path
        name: entitlement_id
        required: true
        schema:
          description: The entitlement_id field for the app entitlement to remove the owner of.
          readOnly: false
          type: string
      - in: path
        name: user_id
        required: true
        schema:
          description: The user_id field for the user to remove as an owner of the app entitlement.
          readOnly: false
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.app.v1.RemoveAppEntitlementOwnerRequestInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.app.v1.RemoveAppEntitlementOwnerResponse'
          description: The empty response message for removing an app entitlement owner.
      summary: Remove
      tags:
      - App Entitlement Owner
      x-speakeasy-group: AppEntitlementOwners
      x-speakeasy-name-override: Remove
components:
  schemas:
    c1.api.app.v1.DeleteAppEntitlementOwnersResponse:
      description: the empty response message for deleting app entitlement owners.
      title: Delete App Entitlement Owners Response
      type: object
      x-speakeasy-name-override: DeleteAppEntitlementOwnersResponse
    c1.api.app.v1.ListAppEntitlementOwnerIDsResponse:
      description: The response message for listing app entitlement owners IDs.
      properties:
        userIds:
          description: The list of owner IDs for the app entitlement.
          items:
            type: string
          nullable: true
          readOnly: false
          type: array
      title: List App Entitlement Owner I Ds Response
      type: object
      x-speakeasy-name-override: ListAppEntitlementOwnerIDsResponse
    c1.api.app.v1.ListAppEntitlementOwnersResponse:
      description: The response message for listing app entitlement owners.
      properties:
        list:
          description: The list of owners for the app entitlement.
          items:
            $ref: '#/components/schemas/c1.api.user.v1.User'
          nullable: true
          readOnly: false
          type: array
        nextPageToken:
          description: "The nextPageToken is shown for the next page if the number of results is larger than the max page size.\n The server returns one page of results and the nextPageToken until all results are retreived.\n To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page."
          readOnly: false
          type: string
      title: List App Entitlement Owners Response
      type: object
      x-speakeasy-name-override: ListAppEntitlementOwnersResponse
    c1.api.user.v1.UserAttributeMappingSource:
      description: The UserAttributeMappingSource message.
      properties:
        appId:
          description: The appId field.
          readOnly: false
          type: string
        appUserId:
          description: The appUserId field.
          readOnly: false
          type: string
        appUserProfileAttributeKey:
          description: The appUserProfileAttributeKey field.
          readOnly: false
          type: string
        userAttributeMappingId:
          description: The userAttributeMappingId field.
          readOnly: false
          type: string
        value:
          description: The value field.
          readOnly: false
          type: string
      title: User Attribute Mapping Source
      type: object
      x-speakeasy-name-override: UserAttributeMappingSource
    c1.api.user.v1.User:
      description: The User object provides all of the details for an user, as well as some configuration.
      properties:
        createdAt:
          format: date-time
          readOnly: true
          type: string
        delegatedUserId:
          description: The id of the user to whom tasks will be automatically reassigned to.
          readOnly: false
          type: string
        deletedAt:
          format: date-time
          readOnly: true
          type: string
        department:
          description: The department which the user belongs to in the organization.
          readOnly: true
          type: string
        departmentSources:
          description: A list of objects mapped based on department attribute mappings configured in the system.
          items:
            $ref: '#/components/schemas/c1.api.user.v1.UserAttributeMappingSource'
          nullable: true
          readOnly: true
          type: array
        directoryIds:
          description: A list of unique ids that represent different directories.
          items:
            type: string
          nullable: true
          readOnly: true
          type: array
        directoryStatus:
          description: The status of the user in the directory.
          enum:
          - UNKNOWN
          - ENABLED
          - DISABLED
          - DELETED
          readOnly: true
          type: string
          x-speakeasy-unknown-values: allow
        directoryStatusSources:
          description: A list of objects mapped based on directoryStatus attribute mappings configured in the system.
          items:
            $ref: '#/components/schemas/c1.api.user.v1.UserAttributeMappingSource'
          nullable: true
          readOnly: true
          type: array
        displayName:
          description: The display name of the user.
          readOnly: true
          type: string
        email:
          description: This is the user's email.
          readOnly: true
          type: string
        emailSources:
          description: A list of source data for the email attribute.
          items:
            $ref: '#/components/schemas/c1.api.user.v1.UserAttributeMappingSource'
          nullable: true
          readOnly: true
          type: array
        emails:
          description: This is a list of all of the user's emails from app users.
          items:
            type: string
          nullable: true
          readOnly: true
          type: array
        employeeIdSources:
          description: A list of source data for the employee IDs attribute.
          items:
            $ref: '#/components/schemas/c1.api.user.v1.UserAttributeMappingSource'
          nullable: true
          readOnly: true
          type: array
        employeeIds:
          description: This is a list of all of the user's employee IDs from app users.
          items:
            type: string
          nullable: true
          readOnly: true
          type: array
        employmentStatus:
          description: The users employment status.
          readOnly: true
          type: string
        employmentStatusSources:
          description: A list of objects mapped based on employmentStatus attribute mappings configured in the system.
          items:
            $ref: '#/components/schemas/c1.api.user.v1.UserAttributeMappingSource'
          nullable: true
          readOnly: true
          type: array
        employmentType:
          description: The employment type of the user.
          readOnly: true
          type: string
        employmentTypeSources:
          description: A list of objects mapped based on employmentType attribute mappings configured in the system.
          items:
            $ref: '#/components/schemas/c1.api.user.v1.UserAttributeMappingSource'
          nullable: true
          readOnly: true
          type: array
        id:
          description: A unique identifier of the user.
          readOnly: true
          type: string
        jobTitle:
          description: The job title of the user.
          readOnly: true
          type: string
        jobTitleSources:
          description: A list of objects mapped based on jobTitle attribute mappings configured in the system.
          items:
            $ref: '#/components/schemas/c1.api.user.v1.UserAttributeMappingSource'
          nullable: true
          readOnly: true
          type: array
        managerIds:
          description: A list of ids of the user's managers.
          items:
            type: string
          nullable: true
          readOnly: true
          type: array
        managerSources:
          description: A list of objects mapped based on managerId attribute mappings configured in the system.
          items:
            $ref: '#/components/schemas/c1.api.user.v1.UserAttributeMappingSource'
          nullable: true
          readOnly: true
          type: array
        profile:
          additionalProperties: true
          readOnly: true
          type: object
        roleIds:
          description: A list of unique identifiers that maps to ConductorOne's user roles let you assign users permissions tailored to the work they do in the software.
          items:
            type: string
          nullable: true
          readOnly: false
          type: array
        status:
          description: The status of the user in the system.
          enum:
          - UNKNOWN
          - ENABLED
          - DISABLED
          - DELETED
          readOnly: false
          type: string
          x-speakeasy-unknown-values: allow
        type:
          description: The type of the user.
          enum:
          - USER_TYPE_UNSPECIFIED
          - USER_TYPE_SYSTEM
          - USER_TYPE_HUMAN
          - USER_TYPE_SERVICE
          - USER_TYPE_AGENT
          readOnly: true
          type: string
          x-speakeasy-unknown-values: allow
        updatedAt:
          format: date-time
          readOnly: true
          type: string
        username:
          description: This is the user's primary username. Typically sourced from the primary directory.
          readOnly: true
          type: string
        usernameSources:
          description: A list of source data for the usernames attribute.
          items:
            $ref: '#/components/schemas/c1.api.user.v1.UserAttributeMappingSource'
          nullable: true
          readOnly: true
          type: array
        usernames:
          description: This is a list of all of the user's usernames from app users.
          items:
            type: string
          nullable: true
          readOnly: true
          type: array
      title: User
      type: object
      x-speakeasy-name-override: User
    c1.api.app.v1.AddAppEntitlementOwnerRequestInput:
      description: The request message for adding an app entitlement owner.
      properties:
        userId:
          description: The user_id field for the user to add as an owner of the app entitlement.
          readOnly: false
          type: string
      title: Add App Entitlement Owner Request
      type: object
      x-speakeasy-name-override: AddAppEntitlementOwnerRequest
    c1.api.app.v1.DeleteAppEntitlementOwnersRequestInput:
      description: The request message for deleting app entitlement owners.
      title: Delete App Entitlement Owners Request
      type: object
      x-speakeasy-name-override: DeleteAppEntitlementOwnersRequest
    c1.api.app.v1.AddAppEntitlementOwnerResponse:
      description: The empty response message for adding an app entitlement owner.
      title: Add App Entitlement Owner Response
      type: object
      x-speakeasy-name-override: AddAppEntitlementOwnerResponse
    c1.api.app.v1.RemoveAppEntitlementOwnerResponse:
      description: The empty response message for removing an app entitlement owner.
      title: Remove App Entitlement Owner Response
      type: object
      x-speakeasy-name-override: RemoveAppEntitlementOwnerResponse
    c1.api.app.v1.SetAppEntitlementOwnersResponse:
      description: The empty response message for setting the app entitlement owners.
      title: Set App Entitlement Owners Response
      type: object
      x-speakeasy-name-override: SetAppEntitlementOwnersResponse
    c1.api.app.v1.SetAppEntitlementOwnersRequestInput:
      description: The request message for setting the app entitlement owners.
      properties:
        userIds:
          description: The user_ids field for the users to set as an owner of the app entitlement.
          items:
            type: string
          nullable: true
          readOnly: false
          type: array
      title: Set App Entitlement Owners Request
      type: object
      x-speakeasy-entity: App_Entitlement_Owner
      x-speakeasy-name-override: SetAppEntitlementOwnersRequest
    c1.api.app.v1.RemoveAppEntitlementOwnerRequestInput:
      description: The request message for removing an app entitlement owner.
      title: Remove App Entitlement Owner Request
      type: object
      x-speakeasy-name-override: RemoveAppEntitlementOwnerRequest
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http
    oauth:
      description: 'This API uses OAuth2 with the Client Credential flow.

        Client Credentials must be sent in the BODY, not the headers.

        For an example of how to implement this, refer to the [c1TokenSource.Token()](https://github.com/ConductorOne/conductorone-sdk-go/blob/3375fe7c0126d17e7ec4e711693dee7b791023aa/token_source.go#L101-L187) function.'
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: /auth/v1/token
      type: oauth2