C1

C1 App Entitlement User Binding API

The App Entitlement User Binding API from C1 — 3 operation(s) for app entitlement user binding.

OpenAPI Specification

c1-app-entitlement-user-binding-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  description: The ConductorOne API is a HTTP API for managing ConductorOne resources.
  title: ConductorOne Access Conflict App Entitlement User Binding 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 User Binding
paths:
  /api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/users/{app_user_id}/remove-grant-duration:
    post:
      description: Invokes the c1.api.app.v1.AppEntitlementUserBindingService.RemoveGrantDuration method.
      operationId: c1.api.app.v1.AppEntitlementUserBindingService.RemoveGrantDuration
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          description: The appId field.
          readOnly: false
          type: string
      - in: path
        name: app_entitlement_id
        required: true
        schema:
          description: The appEntitlementId field.
          readOnly: false
          type: string
      - in: path
        name: app_user_id
        required: true
        schema:
          description: The appUserId field.
          readOnly: false
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.app.v1.RemoveGrantDurationRequestInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.app.v1.RemoveGrantDurationResponse'
          description: Successful response
      summary: Remove Grant Duration
      tags:
      - App Entitlement User Binding
      x-speakeasy-group: AppEntitlementUserBinding
      x-speakeasy-name-override: RemoveGrantDuration
  /api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/users/{app_user_id}/update-grant-duration:
    post:
      description: Invokes the c1.api.app.v1.AppEntitlementUserBindingService.UpdateGrantDuration method.
      operationId: c1.api.app.v1.AppEntitlementUserBindingService.UpdateGrantDuration
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          description: The appId field.
          readOnly: false
          type: string
      - in: path
        name: app_entitlement_id
        required: true
        schema:
          description: The appEntitlementId field.
          readOnly: false
          type: string
      - in: path
        name: app_user_id
        required: true
        schema:
          description: The appUserId field.
          readOnly: false
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.app.v1.UpdateGrantDurationRequestInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.app.v1.UpdateGrantDurationResponse'
          description: Successful response
      summary: Update Grant Duration
      tags:
      - App Entitlement User Binding
      x-speakeasy-group: AppEntitlementUserBinding
      x-speakeasy-name-override: UpdateGrantDuration
  /api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/users/{identity_user_id}/grants:
    get:
      description: Returns a list of app users for the identity in the app. If that app user also has a grant to the entitlement from the request, data about the grant is also returned. It will always return ALL app users for this identity, but only SOME may have grant data.
      operationId: c1.api.app.v1.AppEntitlementUserBindingService.ListAppUsersForIdentityWithGrant
      parameters:
      - in: path
        name: app_id
        required: true
        schema:
          description: The appId field.
          readOnly: false
          type: string
      - in: path
        name: app_entitlement_id
        required: true
        schema:
          description: The appEntitlementId field.
          readOnly: false
          type: string
      - in: path
        name: identity_user_id
        required: true
        schema:
          description: The identityUserId field.
          readOnly: false
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.app.v1.ListAppUsersForIdentityWithGrantResponse'
          description: Successful response
      summary: List App Users For Identity With Grant
      tags:
      - App Entitlement User Binding
      x-speakeasy-group: AppEntitlementUserBinding
      x-speakeasy-name-override: ListAppUsersForIdentityWithGrant
components:
  schemas:
    c1.api.app.v1.RemoveGrantDurationResponse:
      description: The RemoveGrantDurationResponse message.
      properties:
        binding:
          $ref: '#/components/schemas/c1.api.app.v1.AppEntitlementUserBinding'
      title: Remove Grant Duration Response
      type: object
      x-speakeasy-name-override: RemoveGrantDurationResponse
    c1.api.app.v1.ListAppUsersForIdentityWithGrantResponse:
      description: The ListAppUsersForIdentityWithGrantResponse message.
      properties:
        bindings:
          description: "The list of app users that may also have grant information.\n Without a grant, only the tenant, app, and app user ID will be set. With a grant, the whole struct is populated"
          items:
            $ref: '#/components/schemas/c1.api.app.v1.AppEntitlementUserBinding'
          nullable: true
          readOnly: false
          type: array
      title: List App Users For Identity With Grant Response
      type: object
      x-speakeasy-name-override: ListAppUsersForIdentityWithGrantResponse
    c1.api.app.v1.AppEntitlementUserBinding:
      description: The AppEntitlementUserBinding represents the relationship that gives an app user access to an app entitlement
      properties:
        appEntitlementId:
          description: The ID of the app entitlement that the app user has access to
          readOnly: false
          type: string
        appId:
          description: The ID of the app associated with the app entitlement
          readOnly: false
          type: string
        appUserId:
          description: The ID of the app user that has access to the app entitlement
          readOnly: false
          type: string
        createdAt:
          format: date-time
          readOnly: true
          type: string
        deletedAt:
          format: date-time
          readOnly: true
          type: string
        deprovisionAt:
          format: date-time
          readOnly: true
          type: string
        grantSources:
          description: The grantSources field.
          items:
            $ref: '#/components/schemas/c1.api.app.v1.AppEntitlementRef'
          nullable: true
          readOnly: false
          type: array
      title: App Entitlement User Binding
      type: object
      x-speakeasy-name-override: AppEntitlementUserBinding
    c1.api.app.v1.RemoveGrantDurationRequestInput:
      description: The RemoveGrantDurationRequest message.
      title: Remove Grant Duration Request
      type: object
      x-speakeasy-name-override: RemoveGrantDurationRequest
    c1.api.app.v1.UpdateGrantDurationResponse:
      description: The UpdateGrantDurationResponse message.
      properties:
        binding:
          $ref: '#/components/schemas/c1.api.app.v1.AppEntitlementUserBinding'
      title: Update Grant Duration Response
      type: object
      x-speakeasy-name-override: UpdateGrantDurationResponse
    c1.api.app.v1.AppEntitlementRef:
      description: The AppEntitlementRef message.
      properties:
        appId:
          description: The appId field.
          readOnly: false
          type: string
        id:
          description: The id field.
          readOnly: false
          type: string
      title: App Entitlement Ref
      type: object
      x-speakeasy-name-override: AppEntitlementRef
    c1.api.app.v1.UpdateGrantDurationRequestInput:
      description: The UpdateGrantDurationRequest message.
      properties:
        newDeprovisionAt:
          format: date-time
          readOnly: false
          type: string
      title: Update Grant Duration Request
      type: object
      x-speakeasy-name-override: UpdateGrantDurationRequest
  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