governance-production-requests-admin-v1-reference-noEnums-oneOfInheritance.yaml

openapi: 3.0.3
info:
  title: Access Requests - V1
  description: Allows customers to easily access the Okta API
  termsOfService: https://developer.okta.com/terms/
  contact:
    name: Okta Developer Team
    url: https://developer.okta.com/
    email: devex-public@okta.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 3.2.0
  x-logo:
    url: logo.svg
    backgroundColor: transparent
    altText: Okta Developer
servers:
  - url: https://{yourOktaDomain}
    variables:
      yourOktaDomain:
        default: subdomain.okta.com
        description: The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains.
tags:
  - name: Request Types
    description: |
      The Request Types API allows you to manage request types, similar to the operations performed in the Okta Access Requests app. Use this API to define request types that include:

      - Fields to complete
      - Approvals and tasks required
      - Actions performed in Okta

      See [Access Request Types](https://help.okta.com/okta_help.htm?type=oie&id=ext-ar-reqtype) in the product documentation.

      > **Notes**:
      >
      > * Each org has a limit of 500 active request types.
      > * Operations to create or delete apps or groups in Okta could take up to 24 hours before they can be referenced by the Access Requests - V1 APIs. To trigger these changes immediately, open Okta Access Requests as an administrator, go to **Settings** > **Configuration** and click **Sync Now** on the relevant Okta resource list.
  - name: Requests
    description: |
      Okta Access Requests automate the process of requesting access to resources like apps, groups, and entitlement bundles. 
      Each request is associated with a request approval process that determines the actions taken by Okta Access Requests. 
      Manage this process directly with the following request APIs.

      See [Access Requests](https://help.okta.com/okta_help.htm?type=oie&id=ext-ar) for more information on Access Requests 
      and Identity Governance.
externalDocs:
  description: Find more info here
  url: https://developer.okta.com/docs/reference/core-okta-api/#design-principles
paths:
  /governance/api/v1/request-types:
    post:
      x-okta-lifecycle:
        lifecycle: BETA
      x-okta-iam-admin-roles:
        - ACCESS_REQUESTS_ADMIN
      tags:
        - Request Types
      operationId: createRequestType
      summary: Create a request type
      description: |
        Creates a request type that governs the requests allowed in your org.

        Specify the following to create a request type:

        - What resource access can be requested
        - Who can request access
        - What question(s) requesters must answer (optional)
        - Who can approve access
        - What question(s) approvers must answer (optional)
        - How long access should be granted for (optional)

        > **Notes**:
        >
        > * You can have a maximum of 100 combined items across `approvalSettings.approvals`, `approvalSettings.approvals.approverFields`, and `requestSettings.requesterFields` objects for each request type. This translates to a maximum of 100 combined questions, tasks, or actions for each request type.
        > * The limit on the JSON response payload of a request type is 100,000 characters.
      security:
        - ApiKey:
            - admin
        - OAuth2:
            - okta.governance.accessRequests.manage
      requestBody:
        required: true
        description: The writable attributes of a request type
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/request-type-creatable'
            examples:
              Minimal:
                $ref: '#/components/examples/request-type-creatable-00-minimal-example'
              IncludingDefaults:
                $ref: '#/components/examples/request-type-creatable-01-request-anyone-no-questions-example'
              GroupManager:
                $ref: '#/components/examples/request-type-creatable-02-group-manager-example'
              AppManager:
                $ref: '#/components/examples/request-type-creatable-03-app-manager-example'
              AppManagerSelectField:
                $ref: '#/components/examples/request-type-creatable-04-app-manager-select-field-example'
              AppManagerTextField:
                $ref: '#/components/examples/request-type-creatable-05-app-manager-text-field-example'
              AppManagerDatetimeField:
                $ref: '#/components/examples/request-type-creatable-06-app-manager-datetime-field-example'
              MultistepApproval:
                $ref: '#/components/examples/request-type-creatable-07-approval-multi-step-example'
              OptionalQuestions:
                $ref: '#/components/examples/request-type-creatable-08-optional-questions-example'
              RequesterMemberOf:
                $ref: '#/components/examples/request-type-creatable-09-requester-memberof-example'
              PublishedWithAccessDuration:
                $ref: '#/components/examples/request-type-creatable-10-active-example'
              NoApprovals:
                $ref: '#/components/examples/request-type-creatable-11-no-approval-example'
              ApprovalDescription:
                $ref: '#/components/examples/request-type-creatable-12-approval-description-example'
              ResourceOwnerApproval:
                $ref: '#/components/examples/request-type-creatable-13-resource-owner-approval-example'
      responses:
        '201':
          $ref: '#/components/responses/request-types-create-success-response'
        '400':
          $ref: '#/components/responses/request-types-create-bad-request-response'
        '401':
          $ref: '#/components/responses/authentication-error-response'
        '403':
          $ref: '#/components/responses/authorization-error-response'
        '429':
          $ref: '#/components/responses/rate-limit-exceeded-response'
        '500':
          $ref: '#/components/responses/unexpected-error-response'
    get:
      x-okta-lifecycle:
        lifecycle: BETA
      tags:
        - Request Types
      operationId: listAllRequestTypes
      summary: List all request types
      description: |-
        Lists all or a subset of request types in your organization.

        Use the `?filter=` parameter to narrow results with the following request type properties: `status` and `lastUpdated`.

        Pagination parameters are accepted, and standard link headers are in the response.
      parameters:
        - $ref: '#/components/parameters/request-types-list-filter'
        - $ref: '#/components/parameters/request-types-list-after'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/request-types-list-order-by'
      security:
        - ApiKey:
            - admin
        - OAuth2:
            - okta.governance.accessRequests.read
      responses:
        '200':
          $ref: '#/components/responses/request-types-list-success'
        '400':
          $ref: '#/components/responses/request-types-list-bad-request'
        '401':
          $ref: '#/components/responses/authentication-error-response'
        '403':
          $ref: '#/components/responses/authorization-error-response'
        '404':
          $ref: '#/components/responses/resource-not-found-response'
        '429':
          $ref: '#/components/responses/rate-limit-exceeded-response'
        '500':
          $ref: '#/components/responses/unexpected-error-response'
  /governance/api/v1/request-types/{requestTypeId}:
    get:
      x-okta-lifecycle:
        lifecycle: BETA
      x-okta-iam-admin-roles:
        - ACCESS_REQUESTS_ADMIN
      tags:
        - Request Types
      operationId: getRequestType
      summary: Retrieve a request type
      description: |-
        Retrieves the full representation of a specific request type.

        More information is returned than the abbreviated representation in a List request types operation.
      parameters:
        - $ref: '#/components/parameters/request-type-id'
      security:
        - ApiKey:
            - admin
        - OAuth2:
            - okta.governance.accessRequests.read
      responses:
        '200':
          $ref: '#/components/responses/request-type-get-success'
        '401':
          $ref: '#/components/responses/authentication-error-response'
        '403':
          $ref: '#/components/responses/authorization-error-response'
        '404':
          $ref: '#/components/responses/resource-not-found-response'
        '429':
          $ref: '#/components/responses/rate-limit-exceeded-response'
        '500':
          $ref: '#/components/responses/unexpected-error-response'
    delete:
      x-okta-lifecycle:
        lifecycle: BETA
      x-okta-iam-admin-roles:
        - ACCESS_REQUESTS_ADMIN
      tags:
        - Request Types
      operationId: deleteRequestType
      summary: Delete a request type
      description: |
        Deletes a request type from your organization.

        A deleted request type:

        - Can no longer be used to add requests
        - Can no longer be unpublished or published
        - Is no longer available for Get or List operations

        >**Note:** In-flight requests using the `DELETED` request type continue in their lifecycle operations using the state of the request type at the time the request was made.
      parameters:
        - $ref: '#/components/parameters/request-type-id'
      security:
        - ApiKey:
            - admin
        - OAuth2:
            - okta.governance.accessRequests.manage
      responses:
        '204':
          $ref: '#/components/responses/request-type-delete-success-response'
        '401':
          $ref: '#/components/responses/authentication-error-response'
        '403':
          $ref: '#/components/responses/authorization-error-response'
        '404':
          $ref: '#/components/responses/resource-not-found-response'
        '429':
          $ref: '#/components/responses/rate-limit-exceeded-response'
        '500':
          $ref: '#/components/responses/unexpected-error-response'
  /governance/api/v1/request-types/{requestTypeId}/publish:
    post:
      x-okta-lifecycle:
        lifecycle: BETA
      x-okta-iam-admin-roles:
        - ACCESS_REQUESTS_ADMIN
      tags:
        - Request Types
      operationId: publishRequestType
      summary: Publish a request type
      description: |
        Publishes a request type to your organziation.

        A published request type:

        - Can be used to create requests
        - Can be viewed by non-administrative users
        - Sets the request type's status to `ACTIVE`

        A request type with a status of `ACTIVE` can be unpublished or deleted at any time.
      parameters:
        - $ref: '#/components/parameters/request-type-id'
      security:
        - ApiKey:
            - admin
        - OAuth2:
            - okta.governance.accessRequests.manage
      responses:
        '200':
          $ref: '#/components/responses/request-type-publish-success-response'
        '401':
          $ref: '#/components/responses/authentication-error-response'
        '403':
          $ref: '#/components/responses/authorization-error-response'
        '404':
          $ref: '#/components/responses/resource-not-found-response'
        '409':
          $ref: '#/components/responses/request-type-publish-conflict-response'
        '429':
          $ref: '#/components/responses/rate-limit-exceeded-response'
        '500':
          $ref: '#/components/responses/unexpected-error-response'
  /governance/api/v1/request-types/{requestTypeId}/un-publish:
    post:
      x-okta-lifecycle:
        lifecycle: BETA
      x-okta-iam-admin-roles:
        - ACCESS_REQUESTS_ADMIN
      tags:
        - Request Types
      operationId: unpublishRequestType
      summary: Unpublish a request type
      description: |
        Unpublishes a request type, which returns the status of the request type to `DRAFT`.

        An unpublished Request Type:

        - Can't be used to add new requests
        - Is not visible to non-administrative users

        >**Note:** In-flight requests continue in their lifecycle using the request type definition from the point in time the request was created.

        A request type with a status of `DRAFT` can be published or deleted at any time.
      parameters:
        - $ref: '#/components/parameters/request-type-id'
      security:
        - ApiKey:
            - admin
        - OAuth2:
            - okta.governance.accessRequests.manage
      responses:
        '200':
          $ref: '#/components/responses/request-type-un-publish-success-response'
        '401':
          $ref: '#/components/responses/authentication-error-response'
        '403':
          $ref: '#/components/responses/authorization-error-response'
        '404':
          $ref: '#/components/responses/resource-not-found-response'
        '409':
          $ref: '#/components/responses/request-type-un-publish-conflict-response'
        '429':
          $ref: '#/components/responses/rate-limit-exceeded-response'
        '500':
          $ref: '#/components/responses/unexpected-error-response'
  /governance/api/v1/requests:
    get:
      x-okta-lifecycle:
        lifecycle: BETA
      x-okta-iam-admin-roles:
        - ACCESS_REQUESTS_ADMIN
      tags:
        - Requests
      operationId: listAllRequests
      summary: List all requests
      description: |
        Lists all or a subset of requests made by users in your organization.

        Use the `?filter=` parameter to narrow results with the following request properties: `requestStatus` and `lastUpdated`.

        Pagination parameters are accepted, and standard link headers are in the response.
      parameters:
        - $ref: '#/components/parameters/request-list-filter'
        - $ref: '#/components/parameters/request-list-after'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/request-list-order-by'
      security:
        - OAuth2:
            - okta.governance.accessRequests.read
      responses:
        '200':
          $ref: '#/components/responses/requests-list-success'
        '400':
          $ref: '#/components/responses/requests-list-bad-request'
        '401':
          $ref: '#/components/responses/authentication-error-response'
        '403':
          $ref: '#/components/responses/authorization-error-response'
        '429':
          $ref: '#/components/responses/rate-limit-exceeded-response'
        '500':
          $ref: '#/components/responses/unexpected-error-response'
    post:
      x-okta-lifecycle:
        lifecycle: BETA
      x-okta-iam-admin-roles:
        - ACCESS_REQUESTS_ADMIN
      operationId: createRequest
      tags:
        - Requests
      summary: Create a request
      description: |
        Creates a request to access a resource in your organization.

        When creating a request, you specify:

        - the request type (`requestTypeId`) to use for the request
        - and the subject line (`subject`) of the request

        Optionally, you can specify:

        - The requester user IDs for the request. If not provided, user IDs are obtained from the user identity of the `API Token` or `Access Token`.
      requestBody:
        required: true
        description: The writable attributes of a request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/request-creatable'
            examples:
              NoRequester:
                $ref: '#/components/examples/request-00-create-no-requester-example'
              Requester:
                $ref: '#/components/examples/request-01-create-requester-example'
              RequestHasRequesterFieldValues:
                $ref: '#/components/examples/request-02-create-field-values-example'
      security:
        - ApiKey:
            - admin
        - OAuth2:
            - okta.governance.accessRequests.manage
      responses:
        '201':
          $ref: '#/components/responses/request-create-success-response'
        '400':
          $ref: '#/components/responses/request-create-bad-request-response'
        '401':
          $ref: '#/components/responses/authentication-error-response'
        '403':
          $ref: '#/components/responses/request-create-forbidden-response'
        '409':
          $ref: '#/components/responses/request-create-conflict-response'
        '500':
          $ref: '#/components/responses/unexpected-error-response'
  /governance/api/v1/requests/{requestId}:
    get:
      x-okta-lifecycle:
        lifecycle: BETA
      x-okta-iam-admin-roles:
        - ACCESS_REQUESTS_ADMIN
      tags:
        - Requests
      operationId: getRequest
      summary: Retrieve a request
      description: |
        Retrieves the full representation of a specific request

        More information is returned than the abbreviated representation in a [List all requests](/iga/openapi/governance-production-requests-admin-v1-reference/requests/listallrequests) operation.
      parameters:
        - $ref: '#/components/parameters/request-id'
      security:
        - ApiKey:
            - admin
        - OAuth2:
            - okta.governance.accessRequests.read
      responses:
        '200':
          $ref: '#/components/responses/request-get-success'
        '401':
          $ref: '#/components/responses/authentication-error-response'
        '403':
          $ref: '#/components/responses/authorization-error-response'
        '404':
          $ref: '#/components/responses/resource-not-found-response'
        '429':
          $ref: '#/components/responses/rate-limit-exceeded-response'
        '500':
          $ref: '#/components/responses/unexpected-error-response'
  /governance/api/v1/requests/{requestId}/messages:
    post:
      x-okta-lifecycle:
        lifecycle: BETA
      x-okta-iam-admin-roles:
        - ACCESS_REQUESTS_ADMIN
      tags:
        - Requests
      operationId: createRequestMessage
      summary: Create a Message for a Request
      description: |
        Creates a message to add context to the request. Message will be authored by the authenticated user and display as "Sent via API".
      parameters:
        - $ref: '#/components/parameters/request-id'
      security:
        - ApiKey:
            - admin
        - OAuth2:
            - okta.governance.accessRequests.manage
      requestBody:
        required: true
        description: The writable attributes of a request message
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/request-message-creatable'
            examples:
              ViewersAll:
                $ref: '#/components/examples/request-message-00-create-message-audience-all'
              ReferenceToAnotherSystem:
                $ref: '#/components/examples/request-message-01-create-message-referencing-another-system'
              MaxMessageLimit:
                $ref: '#/components/examples/request-message-02-create-message-max-message-limit'
      responses:
        '201':
          description: A successful create request message response
        '401':
          $ref: '#/components/responses/authentication-error-response'
        '429':
          $ref: '#/components/responses/rate-limit-exceeded-response'
        '500':
          $ref: '#/components/responses/unexpected-error-response'
  /governance/api/v1/teams:
    get:
      x-okta-lifecycle:
        lifecycle: BETA
      x-okta-iam-admin-roles:
        - ACCESS_REQUESTS_ADMIN
      tags:
        - Request Types
      operationId: listAllRequestTeams
      summary: List all teams
      description: |
        Lists all or a subset of teams in your organization.

        Use the `?filter=` parameter to narrow results with the request type property `name`. This query is useful for specifying the `ownerId` of a request type.

        Pagination parameters are accepted, and standard link headers are in the response.
      parameters:
        - $ref: '#/components/parameters/teams-filter'
        - $ref: '#/components/parameters/teams-after'
        - $ref: '#/components/parameters/limit'
      security:
        - ApiKey:
            - admin
        - OAuth2:
            - okta.governance.accessRequests.read
      responses:
        '200':
          $ref: '#/components/responses/teams-list-success'
        '400':
          $ref: '#/components/responses/teams-list-bad-request'
        '401':
          $ref: '#/components/responses/authentication-error-response'
        '403':
          $ref: '#/components/responses/authorization-error-response'
        '500':
          $ref: '#/components/responses/unexpected-error-response'
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      description: 'Pass the `access_token` as the value of the Authorization header: `Authorization: Bearer {access_token}`. See [Make a request](https://developer.okta.com/docs/guides/implement-oauth-for-okta-serviceapp/main/#make-a-request).'
      flows:
        authorizationCode:
          authorizationUrl: /oauth2/v1/authorize
          tokenUrl: /oauth2/v1/token
          scopes:
            okta.governance.accessCertifications.manage: Allows the app to create and manage Access Certification Campaigns
            okta.governance.accessCertifications.read: Allows the app to read information about Access Certification Campaigns and Reviews in your Okta org
            okta.governance.accessRequests.manage: Allows the app to create and manage V1 Access Requests, Request Types, and Teams
            okta.governance.accessRequests.read: Allows the app to read information about V1 Access Requests, Request Types, and Teams in your Okta org
            okta.governance.entitlements.read: Allows the app to read information about Entitlements, Entitlement bundles, and Grants
            okta.governance.entitlements.manage: Allows the app to create and manage Entitlements, Entitlement bundles, and Grants
            okta.accessRequests.catalog.read: Allows the app to read information about Access Request Catalogs in your Okta org
            okta.accessRequests.condition.manage: Allows the app to create and manage Conditions for the Access Request Resource Catalog
            okta.accessRequests.condition.read: Allows the app to read information about Conditions for the Access Request Resource Catalog
            okta.accessRequests.request.manage: Allows the app to create and manage V2 Access Requests through the Access Request Resource Catalog
            okta.accessRequests.request.read: Allows the app to read information about V2 Access Requests created through the Access Requests Resource Catalog
            okta.governance.collections.manage: Allows the app to create and manage collections
            okta.governance.collections.read: Allows the app to read information about collections in your Okta org
            okta.governance.operations.read: Allows the app to read information about asynchronous operations in your Okta org
            okta.governance.riskRule.manage: Allows the app to create and manage rules
            okta.governance.riskRule.read: Allows the app to read information about rules in your Okta org
            okta.governance.resourceOwner.manage: Allows the app to create and manage resource owners
            okta.governance.resourceOwner.read: Allows the app to read information about resource owners in your Okta org
            okta.governance.labels.manage: Allows the user to create and manage labels
            okta.governance.labels.read: Allows the user to read information about labels in your Okta org
            okta.governance.securityAccessReviews.admin.manage: Allows the admin app to create and manage security access reviews
            okta.governance.securityAccessReviews.admin.read: Allows the admin app to read information about security access reviews
            okta.governance.securityAccessReviews.endUser.manage: Allows the end-user app to create and manage security access reviews
            okta.governance.securityAccessReviews.endUser.read: Allows the end-user app to read information about security access reviews
            okta.governance.principalSettings.manage: Allows the app to create and manage governance settings for any user in your Okta org
            okta.governance.principalSettings.read: Allows the app to read information about governance settings for any user in your Okta org
            okta.governance.settings.manage: Allows the app to create and manage governance settings for your Okta org
            okta.governance.settings.read: Allows the app to read information about governance settings for your Okta org
            okta.governance.delegates.read: Allows the app to read information about delegates in your Okta org
            okta.governance.reviewer.read: Allows the end user to read information about access certification reviews assigned to them
            okta.governance.reviewer.manage: Allows the end user to manage access certification reviews assigned to them
            okta.accessRequests.tasks.manage: Allows the user to manage tasks for access requests in your Okta org
            okta.accessRequests.tasks.read: Allows the user to read information about tasks for access requests in your Okta org
    ApiKey:
      type: apiKey
      name: Authorization
      in: header
      description: 'Pass the API token as the Authorization header value prefixed with SSWS: `Authorization: SSWS {API Token}`.'
  schemas:
    scim-filter:
      type: string
      format: scim-filter
    request-type-id:
      type: string
      maxLength: 24
      minLength: 24
      pattern: ^[a-fA-F\d]{24}$
      format: request-type-id
      description: |
        The request type `id`.
    order-by:
      type: string
      format: order-by
      description: A property of items within the collection, optionally followed by a `%20asc` or `%20desc` suffix.
    writable-standard-properties:
      type: object
      properties:
        name:
          type: string
          nullable: false
          description: A user-defined unique key that's set during the create operation and can't be updated afterwards
          maxLength: 50
          minLength: 1
        description:
          type: string
          nullable: false
          description: Human readable description
          maxLength: 2000
          minLength: 1
      example:
        name: my-object-1
        description: The unique instance of my-object-1
    created-by:
      description: The `id` of the Okta user who created the resource
      type: string
      x-okta-ignore-redocly-rules-for-sdk: true
      readOnly: true
      minLength: 1
      maxLength: 20
      format: okta-user-id
    created:
      description: The ISO 8601 formatted date and time when the resource was created
      type: string
      x-okta-ignore-redocly-rules-for-sdk: true
      format: date-time
      readOnly: true
    last-updated:
      description: The ISO 8601 formatted date and time when the object was last updated
      type: string
      format: date-time
      readOnly: true
    last-updated-by:
      description: The `id` of the Okta user who last updated the object
      type: string
      x-okta-ignore-redocly-rules-for-sdk: true
      readOnly: true
      minLength: 1
      maxLength: 20
      format: okta-user-id
    link:
      type: object
      x-okta-ignore-redocly-rules-for-sdk: true
      description: A link to a related RESTful resource
      required:
        - href
      properties:
        name:
          type: string
          description: Link name
        rel:
          type: string
          description: Link relation
        href:
          type: string
          minLength: 1
          description: Link URI
        type:
          type: string
          description: The media type of the link. If omitted, it's implicitly `application/json`.
        method:
          type: string
          deprecated: true
        templated:
          type: boolean
          description: Indicates whether the link object's `href` property is a URI template
        hints:
          type: object
          description: Link hints
          additionalProperties:
            type: array
            items:
              type: string
        title:
          type: string
          description: Link title or label
    read-only-standard-properties:
      type: object
      x-okta-ignore-redocly-rules-for-sdk: true
      required:
        - id
        - createdBy
        - created
        - lastUpdated
        - lastUpdatedBy
      properties:
        id:
          description: Unique identifier for the object
          type: string
          minLength: 1
        createdBy:
          $ref: '#/components/schemas/created-by'
        created:
          $ref: '#/components/schemas/created'
        lastUpdated:
          $ref: '#/components/schemas/last-updated'
        lastUpdatedBy:
          $ref: '#/components/schemas/last-updated-by'
        _links:
          type: object
          description: Links to related resources
          additionalProperties:
            $ref: '#/components/schemas/link'
    request-type-status:
      type: string
      description: |
        A request type has a status lifecycle described in our [request type lifecycle documentation](/#request-type-status-lifecycle).

        A request type may start with a status of DRAFT or ACTIVE, based on the status property in the Add request body.

        The publish, unpublish, and delete operations all affect a request type's status.

        Additionally, if any operation detects invalid settings, such as an approver who is no longer in the organization, the request type automatically transitions to disabled.
      x-okta-known-values:
        - DRAFT
        - ACTIVE
        - DISABLED
    request-type-links:
      type: object
      description: Links available on a single request type representation
      required:
        - requests
        - self
      properties:
        createRequest:
          description: Only available for request type with status of ACTIVE
          allOf:
            - $ref: '#/components/schemas/link'
        requests:
          $ref: '#/components/schemas/link'
        self:
          $ref: '#/components/schemas/link'
      additionalProperties:
        $ref: '#/components/schemas/link'
    request-type-sparse:
      type: object
      description: Sparse representation of a Request Type resource
      allOf:
        - $ref: '#/components/schemas/writable-standard-properties'
        - $ref: '#/components/schemas/read-only-standard-properties'
      required:
        - id
        - name
        - description
        - lastUpdated
        - lastUpdatedBy
        - status
        - lastUpdateSource
        - _links
      properties:
        status:
          $ref: '#/components/schemas/request-type-status'
        lastUpdateSource:
          type: string
          enum:
            - API
        _links:
          $ref: '#/components/schemas/request-type-links'
      example:
        id: 61eb2db568c7c300079fefd0
        name: salesforce-01
        description: How users can request access to Salesforce 01
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        status: ACTIVE
        lastUpdateSource: API
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=0oa1gjh63g214q0Hq0g4
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2261eb2db568c7c300079fefd0%22
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb2db568c7c300079fefd0
            type: application/json
    request-types-list-links:
      type: object
      description: Links available in request type list response
      required:
        - self
      properties:
        self:
          $ref: '#/components/schemas/link'
        next:
          $ref: '#/components/schemas/link'
      additionalProperties:
        $ref: '#/components/schemas/link'
    request-types-list:
      type: object
      properties:
        data:
          description: All Request Types on the current page
          type: array
          items:
            $ref: '#/components/schemas/request-type-sparse'
        _links:
          $ref: '#/components/schemas/request-types-list-links'
    error-cause:
      type: object
      x-okta-ignore-redocly-rules-for-sdk: true
      description: A specific cause of an error
      required:
        - errorSummary
      properties:
        errorSummary:
          type: string
          description: A more specific summary for the error that contains the error cause
        reason:
          type: string
          description: An enumerated value to represent the reason why the error occurred. This enumeration allows codes to adapt to different conditions in which an error code can occur.
        location:
          type: string
          description: A value that represents the key where the error cause occurred. This is used with `locationType` to give a holistic view of where the error cause occurred. For example, if `locationType` is `body`, `location` is `username`, and the `reason` was `UNIQUE_CONSTRAINT`, you can derive that the username was already taken.
        locationType:
          type: string
          description: A value that represents where the error cause occurred. For example, in the body or header of the request. This value isn't required for cases where the request is correct, but there was another reason why the error occurred (server-side state conflict, rate limit violation, and so on).
        domain:
          type: string
          description: A value that represents the domain of the service in which the error occurs. This value is used to isolate the error cause reason.
    error:
      type: object
      description: An Error object
      required:
        - errorCode
        - errorId
        - errorSummary
      properties:
        errorCode:
          type: string
          description: An error code unique to the error
        errorId:
          type: string
          description: An error identifier useful for troubleshooting an error with support
        errorSummary:
          type: string
          description: An error code description detailing the error
        errorLink:
          type: string
          description: An indicator of where to look to troubleshoot the error
        errorCauses:
          type: array
          description: An optional array of string values that explain possible reasons for the error
          items:
            $ref: '#/components/schemas/error-cause'
    request-type-creatable-status:
      type: string
      default: DRAFT
      description: Whether the request type starts with a status of DRAFT or ACTIVE. Starting as ACTIVE is preferable to avoid a publish operation when no manual inspection of the request type is necessary before publication.
      x-okta-known-values:
        - DRAFT
        - ACTIVE
    request-type-owner-id:
      type: string
      description: The ID of the team that administers this request type.
      maxLength: 24
      minLength: 24
      pattern: ^[a-fA-F\d]{24}$
      format: owner-id
    application-id:
      type: string
      format: okta-application-id
      description: |
        An Okta app ID

        See [List all apps](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/application/other/listapplications) endpoint for more information on how to retrieve app IDs.
      pattern: 0oa[0-9a-zA-Z]+
      maxLength: 20
      minLength: 20
    okta-application-resource:
      type: object
      description: Identifies a unique Okta resource
      required:
        - resourceId
      properties:
        resourceId:
          $ref: '#/components/schemas/application-id'
    request-type-resource-settings-apps:
      type: object
      description: Specifies that all resources must be Okta apps
      required:
        - type
        - targetResources
      properties:
        type:
          type: string
          enum:
            - APPS
        targetResources:
          type: array
          description: List of Okta applications
          minItems: 1
          maxItems: 1
          items:
            $ref: '#/components/schemas/okta-application-resource'
    group-id:
      type: string
      format: okta-group-id
      description: |
        Okta group ID.

        > **Note:** See [List all groups](https://developer.okta.com/docs/api/openapi/okta-management/management/group/listgroups) for more information on how to retrieve group IDs.
      pattern: 00g[0-9a-zA-Z]+
      maxLength: 20
      minLength: 20
    okta-group-resource:
      type: object
      description: Identifies a unique Okta group resource
      required:
        - resourceId
      properties:
        resourceId:
          $ref: '#/components/schemas/group-id'
    request-type-resource-settings-groups:
      type: object
      description: Specifies that all resources must be Okta groups
      required:
        - type
        - targetResources
      properties:
        type:
          type: string
          enum:
            - GROUPS
        targetResources:
          type: array
          description: List of Okta groups
          minItems: 1
          maxItems: 1
          items:
            $ref: '#/components/schemas/okta-group-resource'
    entitlement-bundle-id:
      type: string
      maxLength: 20
      minLength: 20
      format: entitlement-bundle-id
      pattern: enb[0-9a-zA-Z]+
      description: |
        The entitlement bundle `id`
    okta-entitlement-bundle-resource:
      type: object
      description: Identifies a unique Okta entitlement bundle resource
      required:
        - resourceId
      properties:
        resourceId:
          $ref: '#/components/schemas/entitlement-bundle-id'
    request-type-resource-settings-entitlement-bundles:
      type: object
      description: Specifies that all resources must be Okta entitlement bundles
      required:
        - type
        - targetResources
      properties:
        type:
          type: string
          enum:
            - ENTITLEMENT_BUNDLES
        targetResources:
          type: array
          description: List of Okta entitlement bundles
          minItems: 1
          maxItems: 1
          items:
            $ref: '#/components/schemas/okta-entitlement-bundle-resource'
    request-type-resource-settings-mutable:
      type: object
      description: Which resource(s) are requestable
      oneOf:
        - $ref: '#/components/schemas/request-type-resource-settings-apps'
        - $ref: '#/components/schemas/request-type-resource-settings-groups'
        - $ref: '#/components/schemas/request-type-resource-settings-entitlement-bundles'
      discriminator:
        propertyName: type
        mapping:
          APPS: '#/components/schemas/request-type-resource-settings-apps'
          GROUPS: '#/components/schemas/request-type-resource-settings-groups'
          ENTITLEMENT_BUNDLES: '#/components/schemas/request-type-resource-settings-entitlement-bundles'
    okta-push-group-id:
      type: string
      format: okta-push-group-id
      description: An Okta Group ID that's used for push groups in Okta.
      example: 00g1emaKYZTWRYYRRTSK
      pattern: 00g[0-9a-zA-Z]+
      maxLength: 20
      minLength: 20
    member-of:
      type: array
      description: Okta groups that the user persona must be a member of
      minItems: 1
      maxItems: 1
      items:
        $ref: '#/components/schemas/okta-push-group-id'
    field-prompt:
      type: string
      description: Text to prompt the user with
      minLength: 1
      maxLength: 100
      example: What is the business justification?
    field-required:
      type: boolean
      description: Whether a value to this field is required to advance the request
      example: true
      default: true
    base-field-writable:
      type: object
      description: The field to use when prompting the user
      required:
        - prompt
      properties:
        prompt:
          $ref: '#/components/schemas/field-prompt'
        required:
          $ref: '#/components/schemas/field-required'
    field-select-type:
      type: string
      x-okta-known-values:
        - SELECT
    field-option-value:
      type: string
      description: The value of a select option
      maxLength: 280
      minLength: 1
    field-option:
      type: object
      description: An option for the user to select for a field prompt
      required:
        - value
      properties:
        value:
          $ref: '#/components/schemas/field-option-value'
    field-select-options:
      type: array
      description: The options available for the select input
      maxItems: 25
      minItems: 1
      items:
        $ref: '#/components/schemas/field-option'
    field-select-writable:
      type: object
      allOf:
        - $ref: '#/components/schemas/base-field-writable'
      description: A select field
      required:
        - type
        - options
      properties:
        type:
          $ref: '#/components/schemas/field-select-type'
        options:
          $ref: '#/components/schemas/field-select-options'
    field-text-type:
      type: string
      x-okta-known-values:
        - TEXT
    field-text-writable:
      type: object
      allOf:
        - $ref: '#/components/schemas/base-field-writable'
      description: A text field
      required:
        - type
      properties:
        type:
          $ref: '#/components/schemas/field-text-type'
    field-date-time-type:
      type: string
      x-okta-known-values:
        - DATE-TIME
    field-date-writable:
      type: object
      allOf:
        - $ref: '#/components/schemas/base-field-writable'
      description: A date field
      required:
        - type
      properties:
        type:
          $ref: '#/components/schemas/field-date-time-type'
    field-writable:
      description: The field to use when prompting the user
      oneOf:
        - $ref: '#/components/schemas/field-select-writable'
        - $ref: '#/components/schemas/field-text-writable'
        - $ref: '#/components/schemas/field-date-writable'
      discriminator:
        propertyName: type
        mapping:
          SELECT: '#/components/schemas/field-select-writable'
          TEXT: '#/components/schemas/field-text-writable'
          DATE-TIME: '#/components/schemas/field-date-writable'
      default:
        type: TEXT
        required: true
    fields-writable:
      type: array
      description: A list of fields with which to gather input. The order of the fields in the array controls the order that the fields are presented to users.
      default: []
      maxItems: 5
      items:
        $ref: '#/components/schemas/field-writable'
    request-type-requester-member-of-writable:
      type: object
      description: A request where the requester that must be a member of a particular Okta Group.
      required:
        - type
        - requesterMemberOf
      properties:
        type:
          type: string
          enum:
            - MEMBER_OF
        requesterMemberOf:
          $ref: '#/components/schemas/member-of'
        requesterFields:
          $ref: '#/components/schemas/fields-writable'
    request-type-requester-everyone-writable:
      type: object
      description: A request where the requester may be any Okta user in the Okta organization.
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - EVERYONE
        requesterFields:
          $ref: '#/components/schemas/fields-writable'
    request-type-request-settings-mutable:
      type: object
      description: |
        The `requestSettings` control:

        - Which users can request access using this request type.
        - What fields the user may or must fill out in order to request access.
      default:
        type: EVERYONE
        requesterFields: []
      oneOf:
        - $ref: '#/components/schemas/request-type-requester-member-of-writable'
        - $ref: '#/components/schemas/request-type-requester-everyone-writable'
      discriminator:
        propertyName: type
        mapping:
          MEMBER_OF: '#/components/schemas/request-type-requester-member-of-writable'
          EVERYONE: '#/components/schemas/request-type-requester-everyone-writable'
    request-type-approver-fields-writable:
      type: array
      description: |
        A list of fields with which to gather input.

        The order of field object controls the order with which the fields are presented to users.

        #### Known limitation

        Unlike requester fields, all approver fields are *required* and may not be set as optional.
      default: []
      maxItems: 5
      items:
        $ref: '#/components/schemas/field-writable'
    request-type-approval-member-of-writable:
      type: object
      description: An approval when the approver must be a member of a particular Okta Group.
      required:
        - approverType
        - approverMemberOf
      properties:
        approverType:
          type: string
          enum:
            - MEMBER_OF
        description:
          type: string
          minLength: 1
          maxLength: 250
        approverMemberOf:
          $ref: '#/components/schemas/member-of'
        approverFields:
          $ref: '#/components/schemas/request-type-approver-fields-writable'
    user-id:
      type: string
      x-okta-ignore-redocly-rules-for-sdk: true
      format: okta-user-id
      description: The Okta user `id`
      maxLength: 20
      minLength: 20
      pattern: 00u[0-9a-zA-Z]+
      example: 00ub0oNGTSWTBKOLGLNR
    request-type-approval-user-writable:
      type: object
      description: An approval when the approver must be a particular user.
      required:
        - approverType
        - approverUserId
      properties:
        approverType:
          type: string
          enum:
            - USER
        description:
          type: string
          minLength: 1
          maxLength: 250
        approverUserId:
          $ref: '#/components/schemas/user-id'
        approverFields:
          $ref: '#/components/schemas/request-type-approver-fields-writable'
    request-type-approval-manager-writable:
      type: object
      description: Specifying the approver must be the requester's manager
      required:
        - approverType
      properties:
        approverType:
          type: string
          enum:
            - MANAGER
        description:
          type: string
          minLength: 1
          maxLength: 250
        approverFields:
          $ref: '#/components/schemas/request-type-approver-fields-writable'
    request-type-approval-resource-owner-writable:
      type: object
      description: Specifying the approver must be the resource owner
      required:
        - approverType
      properties:
        approverType:
          type: string
          enum:
            - RESOURCE_OWNER
        description:
          type: string
          minLength: 1
          maxLength: 250
    request-type-approval-writable:
      type: object
      description: request-type-approval-description.md
      oneOf:
        - $ref: '#/components/schemas/request-type-approval-member-of-writable'
        - $ref: '#/components/schemas/request-type-approval-user-writable'
        - $ref: '#/components/schemas/request-type-approval-manager-writable'
        - $ref: '#/components/schemas/request-type-approval-resource-owner-writable'
      discriminator:
        propertyName: approverType
        mapping:
          MEMBER_OF: '#/components/schemas/request-type-approval-member-of-writable'
          USER: '#/components/schemas/request-type-approval-user-writable'
          MANAGER: '#/components/schemas/request-type-approval-manager-writable'
          RESOURCE_OWNER: '#/components/schemas/request-type-approval-resource-owner-writable'
    request-type-approvals-writable:
      description: |
        The `SERIAL` approvals required to grant access:

        * All specified approvals are considered required in order to fulfill an access request.
        * At least one approval must be specified for a request type.
        * When a request type has two approvals:
          * Only the first approval is immediately actionable by an approver in the request.
          * After an approver has made a decision for the first approval, then the second approval is actionable.
        * The approval type of `RESOURCE_OWNER` is supported for apps, entitlement bundles, and associated groups from the resource requested.
      type: array
      minItems: 1
      maxItems: 5
      items:
        $ref: '#/components/schemas/request-type-approval-writable'
    request-type-approval-settings-serial-writable:
      type: object
      description: Settings for approval
      required:
        - type
        - approvals
      properties:
        type:
          type: string
          enum:
            - SERIAL
          description: |-
            Multiple approvals defined in a serial sequence:
              * An approval isn't actionable until the previous approval is approved.
              * An approval denial terminates the request and no subsequent approvals are actionable.
        approvals:
          $ref: '#/components/schemas/request-type-approvals-writable'
    request-type-approval-settings-none:
      type: object
      description: Settings for no approvals
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - NONE
          description: No approvals are required for this request type.
    request-type-approval-settings-mutable:
      type: object
      description: |-
        Specify one of the following `type` of approval settings:
          | Type | Description |
          |------|-------------|
          | NONE | This request type doesn't need any approval. |
          | SERIAL | This request type needs at least one approval. |
      oneOf:
        - $ref: '#/components/schemas/request-type-approval-settings-serial-writable'
        - $ref: '#/components/schemas/request-type-approval-settings-none'
      discriminator:
        propertyName: type
        mapping:
          SERIAL: '#/components/schemas/request-type-approval-settings-serial-writable'
          NONE: '#/components/schemas/request-type-approval-settings-none'
    request-duration:
      description: |
        How long the requester retains access after their request is approved and fulfilled.

        Specified in [ISO 8601 duration format](https://en.wikipedia.org/wiki/ISO_8601#Durations).

        #### Known limitation

        Only single time unit ISO 8601 duration formats (D, H, M) are supported for units (days, hours, minutes).

        ##### Supported

        | Unit       | Example |
        | ---------- | ------- |
        | D, days    | P40D    |
        | H, hours   | PT65H   |
        | M, minutes | PT90M   |

        > **Note:** Mixes of units, as well as month/year/week designations, aren't supported. For example, `P40DT65H`, `P40M`, `P1W`, and `P1Y` aren't supported.
      type: string
      example: P40D
      format: iso-duration
      nullable: true
      default: null
    request-type-creatable:
      type: object
      description: The properties expected in an initial Add request
      required:
        - name
        - resourceSettings
        - approvalSettings
        - ownerId
      allOf:
        - $ref: '#/components/schemas/writable-standard-properties'
      properties:
        status:
          $ref: '#/components/schemas/request-type-creatable-status'
        ownerId:
          $ref: '#/components/schemas/request-type-owner-id'
        resourceSettings:
          $ref: '#/components/schemas/request-type-resource-settings-mutable'
        requestSettings:
          $ref: '#/components/schemas/request-type-request-settings-mutable'
        approvalSettings:
          $ref: '#/components/schemas/request-type-approval-settings-mutable'
        accessDuration:
          $ref: '#/components/schemas/request-duration'
      example:
        name: salesforce-01
        description: How users can request access to Salesforce 01
        ownerId: 61eb0f06c462d20007f051ac
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MEMBER_OF
              approverMemberOf:
                - 00g1emaKYZTWRYYRRTSK
              approverFields:
                - prompt: What is the business justification?
                  required: true
                  input:
                    type: TEXT
        resourceSettings:
          type: GROUPS
          targetResources:
            - 00g1emaKYZTWRYYRRTSK
        requestSettings:
          type: EVERYONE
          requesterFields:
            - prompt: What is the business justification?
              required: true
              input:
                type: TEXT
    request-type-resource-settings-custom:
      type: object
      description: Resource settings which cannot be represented in the API accurately. Often the case when lastUpdatedSource is 'WEB'.
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - CUSTOM
    request-type-resource-settings-readable:
      type: object
      description: Which resource(s) are requestable
      oneOf:
        - $ref: '#/components/schemas/request-type-resource-settings-apps'
        - $ref: '#/components/schemas/request-type-resource-settings-groups'
        - $ref: '#/components/schemas/request-type-resource-settings-entitlement-bundles'
        - $ref: '#/components/schemas/request-type-resource-settings-custom'
      required:
        - type
      discriminator:
        propertyName: type
        mapping:
          APPS: '#/components/schemas/request-type-resource-settings-apps'
          GROUPS: '#/components/schemas/request-type-resource-settings-groups'
          ENTITLEMENT_BUNDLES: '#/components/schemas/request-type-resource-settings-entitlement-bundles'
          CUSTOM: '#/components/schemas/request-type-resource-settings-custom'
    field-id:
      type: string
      description: |-
        A `read-only` field ID.

        This field is useful for specifying `requesterFieldValues` when adding a request.

        The generated value is a UUID v4 from [RFC4122](https://www.ietf.org/rfc/rfc4122.txt).
      format: uuid
      maxLength: 36
      minLength: 36
      readOnly: true
      example: 1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed
    base-field-readable:
      type: object
      required:
        - id
      properties:
        id:
          $ref: '#/components/schemas/field-id'
    base-field:
      type: object
      description: The field to use when prompting the user
      allOf:
        - $ref: '#/components/schemas/base-field-writable'
        - $ref: '#/components/schemas/base-field-readable'
    field-select:
      type: object
      allOf:
        - $ref: '#/components/schemas/base-field'
      description: A select field
      required:
        - id
        - type
        - options
      properties:
        type:
          $ref: '#/components/schemas/field-select-type'
        options:
          $ref: '#/components/schemas/field-select-options'
    field-text:
      type: object
      allOf:
        - $ref: '#/components/schemas/base-field'
      description: A text field
      required:
        - id
        - type
      properties:
        type:
          $ref: '#/components/schemas/field-text-type'
    field-date:
      type: object
      allOf:
        - $ref: '#/components/schemas/base-field'
      description: A date field
      required:
        - id
        - type
      properties:
        type:
          $ref: '#/components/schemas/field-date-time-type'
    field:
      type: object
      description: The field to use when prompting the user
      oneOf:
        - $ref: '#/components/schemas/field-select'
        - $ref: '#/components/schemas/field-text'
        - $ref: '#/components/schemas/field-date'
      discriminator:
        propertyName: type
        mapping:
          SELECT: '#/components/schemas/field-select'
          TEXT: '#/components/schemas/field-text'
          DATE-TIME: '#/components/schemas/field-date'
      default:
        type: TEXT
        required: true
    fields:
      type: array
      description: A list of fields to gather input. The order of the fields in the array controls the order that the fields are presented to users.
      default: []
      maxItems: 5
      items:
        $ref: '#/components/schemas/field'
    request-type-requester-member-of:
      type: object
      description: A request where the requester that must be a member of a particular Okta Group.
      required:
        - type
        - requesterMemberOf
      properties:
        type:
          type: string
          enum:
            - MEMBER_OF
        requesterMemberOf:
          $ref: '#/components/schemas/member-of'
        requesterFields:
          $ref: '#/components/schemas/fields'
    request-type-requester-everyone:
      type: object
      description: A request where the requester may be any Okta user in the Okta organization.
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - EVERYONE
        requesterFields:
          $ref: '#/components/schemas/fields'
    request-type-requester-custom:
      type: object
      description: Request settings which cannot be represented in the API accurately. Often the case when lastUpdatedSource is 'WEB'.
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - CUSTOM
    request-type-request-settings-readable:
      type: object
      description: |
        The `requestSettings` control:

        - Which users can request access using this request type.
        - What fields the user may or must fill out in order to request access.
      default:
        type: EVERYONE
        requesterFields: []
      oneOf:
        - $ref: '#/components/schemas/request-type-requester-member-of'
        - $ref: '#/components/schemas/request-type-requester-everyone'
        - $ref: '#/components/schemas/request-type-requester-custom'
      discriminator:
        propertyName: type
        mapping:
          MEMBER_OF: '#/components/schemas/request-type-requester-member-of'
          EVERYONE: '#/components/schemas/request-type-requester-everyone'
          CUSTOM: '#/components/schemas/request-type-requester-custom'
    request-type-approver-fields:
      type: array
      description: |
        A list of fields with which to gather input.

        The order of field object controls the order with which the fields are presented to users.

        #### Known limitation

        Unlike requester fields, all approver fields are *required* and may not be set as optional.
      default: []
      maxItems: 5
      items:
        $ref: '#/components/schemas/field'
    request-type-approval-member-of:
      type: object
      description: An approval when the approver must be a member of a particular Okta Group.
      required:
        - approverType
        - approverMemberOf
      properties:
        approverType:
          type: string
          enum:
            - MEMBER_OF
        description:
          type: string
          minLength: 1
          maxLength: 250
        approverMemberOf:
          $ref: '#/components/schemas/member-of'
        approverFields:
          $ref: '#/components/schemas/request-type-approver-fields'
    request-type-approval-user:
      type: object
      description: An approval when the approver must be a particular user.
      required:
        - approverType
        - approverUserId
      properties:
        approverType:
          type: string
          enum:
            - USER
        description:
          type: string
          minLength: 1
          maxLength: 250
        approverUserId:
          $ref: '#/components/schemas/user-id'
        approverFields:
          $ref: '#/components/schemas/request-type-approver-fields'
    request-type-approval-manager:
      type: object
      description: Specifying the approver must be the requester's manager
      required:
        - approverType
      properties:
        approverType:
          type: string
          enum:
            - MANAGER
        description:
          type: string
          minLength: 1
          maxLength: 250
        approverFields:
          $ref: '#/components/schemas/request-type-approver-fields'
    request-type-approval-resource-owner:
      type: object
      description: Specifying the approver must be the resource owner
      required:
        - approverType
      properties:
        approverType:
          type: string
          enum:
            - RESOURCE_OWNER
        description:
          type: string
          minLength: 1
          maxLength: 250
    request-type-approval:
      type: object
      description: request-type-approval-description.md
      oneOf:
        - $ref: '#/components/schemas/request-type-approval-member-of'
        - $ref: '#/components/schemas/request-type-approval-user'
        - $ref: '#/components/schemas/request-type-approval-manager'
        - $ref: '#/components/schemas/request-type-approval-resource-owner'
      discriminator:
        propertyName: approverType
        mapping:
          MEMBER_OF: '#/components/schemas/request-type-approval-member-of'
          USER: '#/components/schemas/request-type-approval-user'
          MANAGER: '#/components/schemas/request-type-approval-manager'
          RESOURCE_OWNER: '#/components/schemas/request-type-approval-resource-owner'
    request-type-approvals:
      description: |
        The `SERIAL` approvals required to grant access:

        * All specified approvals are considered required in order to fulfill an access request.
        * At least one approval must be specified for a request type.
        * When a request type has two approvals:
          * Only the first approval is immediately actionable by an approver in the request.
          * After an approver has made a decision for the first approval, then the second approval is actionable.
        * The approval type of `RESOURCE_OWNER` is supported for apps, entitlement bundles, and associated groups from the resource requested.
      type: array
      minItems: 1
      maxItems: 5
      items:
        $ref: '#/components/schemas/request-type-approval'
    request-type-approval-settings-serial:
      type: object
      description: Settings for approval
      required:
        - type
        - approvals
      properties:
        type:
          type: string
          enum:
            - SERIAL
          description: |
            When there are multiple approvals, an approval is not actionable until the previous approval has been approved. A denial will terminate the request and no subsequent approvals will be made actionable.
        approvals:
          $ref: '#/components/schemas/request-type-approvals'
    request-type-approval-settings-custom:
      type: object
      description: Approval settings which are not represented in the API accurately. Often the case when lastUpdatedSource is 'WEB'.
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - CUSTOM
          description: |
            `CUSTOM` is set for request types created through the Okta Access Requests app that aren't accurately represented by the `SERIAL` request type model.
    request-type-approval-settings-readable:
      type: object
      description: Approval settings for the request type
      oneOf:
        - $ref: '#/components/schemas/request-type-approval-settings-serial'
        - $ref: '#/components/schemas/request-type-approval-settings-custom'
        - $ref: '#/components/schemas/request-type-approval-settings-none'
      discriminator:
        propertyName: type
        mapping:
          SERIAL: '#/components/schemas/request-type-approval-settings-serial'
          CUSTOM: '#/components/schemas/request-type-approval-settings-custom'
          NONE: '#/components/schemas/request-type-approval-settings-none'
    request-type-last-update-source:
      type: string
      description: Whether the request type was last updated through the API or the user interface.
      x-okta-known-values:
        - API
        - WEB
    request-type-full:
      type: object
      description: Full representation of a request type resource
      allOf:
        - $ref: '#/components/schemas/writable-standard-properties'
        - $ref: '#/components/schemas/read-only-standard-properties'
      required:
        - id
        - name
        - description
        - lastUpdated
        - lastUpdatedBy
        - ownerId
        - resourceSettings
        - requestSettings
        - approvalSettings
        - accessDuration
        - status
        - lastUpdateSource
        - _links
      properties:
        ownerId:
          $ref: '#/components/schemas/request-type-owner-id'
        resourceSettings:
          $ref: '#/components/schemas/request-type-resource-settings-readable'
        requestSettings:
          $ref: '#/components/schemas/request-type-request-settings-readable'
        approvalSettings:
          $ref: '#/components/schemas/request-type-approval-settings-readable'
        accessDuration:
          $ref: '#/components/schemas/request-duration'
        status:
          $ref: '#/components/schemas/request-type-status'
        lastUpdateSource:
          $ref: '#/components/schemas/request-type-last-update-source'
        _links:
          $ref: '#/components/schemas/request-type-links'
      example:
        id: 61eb2db568c7c300079fefd0
        name: salesforce-01
        description: How users can request access to Salesforce 01
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: GROUPS
          targetResources:
            - 00g1emaKYZTWRYYRRTSK
        requestSettings:
          type: EVERYONE
          requesterFields:
            - prompt: What is the business justification?
              required: true
              input:
                type: TEXT
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MEMBER_OF
              approverMemberOf:
                - 00g1emaKYZTWRYYRRTSK
              approverFields:
                - prompt: What is the business justification?
                  required: true
                  input:
                    type: TEXT
        lastUpdateSource: API
        status: ACTIVE
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=0oa1gjh63g214q0Hq0g4
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2261eb2db568c7c300079fefd0%22
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb2db568c7c300079fefd0
            type: application/json
    request-id:
      type: string
      maxLength: 24
      minLength: 24
      pattern: ^[a-fA-F\d]{24}$
      format: request-id
      description: |
        The request `id`
    request-subject:
      type: string
      description: The subject of the request
      maxLength: 250
      minLength: 1
    requester-user-id:
      type: string
      format: okta-user-id
      description: Okta User.id of the requesting user
      maxLength: 20
      minLength: 20
      pattern: 00u[0-9a-zA-Z]+
    requester-user-ids:
      type: array
      minItems: 1
      maxItems: 1
      description: A list of requester Okta user `id`s.
      items:
        $ref: '#/components/schemas/requester-user-id'
    request-mutable:
      type: object
      description: Properties which are mutable in mutation operations
      properties:
        requestTypeId:
          $ref: '#/components/schemas/request-type-id'
        subject:
          $ref: '#/components/schemas/request-subject'
        requesterUserIds:
          $ref: '#/components/schemas/requester-user-ids'
      example:
        subject: Can I have access to Salesforce?
        requestTypeId: 05ab2db568c7c300079fefd0
        requesterUserIds:
          - 00ub0oNGTSWTBKOLGLNR
    request-request-status:
      type: string
      description: |
        A request has a lifecycle. See our [request lifecycle documentation](/#request).

        A request progresses in its lifecycle state based on requester, approver, and administrator activities across a variety of channels, such as:

        - Access Request portal
        - Slack
        - Microsoft teams

        The following lifecycle operations are available on a single request.

        - [Add](/iga/openapi/governance-production-requests-admin-v1-reference/requests/createrequest)
      x-okta-known-values:
        - OPEN
        - PENDING
        - RESOLVED
        - LOCKED
    request-resolved-date-time:
      type: string
      format: date-time
      nullable: true
      description: The date the request was resolved. The property may transition from having a value to null if the request is reopened.
    request-permalink-id:
      type: integer
      description: The immutable, persistent identifier that always resolves to the request
    request-links:
      type: object
      description: Links available on a single request representation
      required:
        - requestType
        - self
      properties:
        requestType:
          $ref: '#/components/schemas/link'
        self:
          $ref: '#/components/schemas/link'
      additionalProperties:
        $ref: '#/components/schemas/link'
    request-sparse:
      type: object
      description: Sparse representation of a Request resource
      allOf:
        - $ref: '#/components/schemas/read-only-standard-properties'
        - $ref: '#/components/schemas/request-mutable'
      required:
        - id
        - createdBy
        - created
        - lastUpdated
        - lastUpdatedBy
        - subject
        - requestTypeId
        - type
        - resolved
        - requestStatus
        - requesterUserIds
        - permalinkId
        - _links
      properties:
        type:
          description: Whether the request's request type has CUSTOM settings or not.
          type: string
          enum:
            - ACCESS_REQUEST
            - CUSTOM
        requestStatus:
          $ref: '#/components/schemas/request-request-status'
        resolved:
          $ref: '#/components/schemas/request-resolved-date-time'
        permalinkId:
          $ref: '#/components/schemas/request-permalink-id'
        _links:
          $ref: '#/components/schemas/request-links'
      example:
        id: 61eb06a3c462d20007f0235c
        subject: request-from-service-now-xsd23432
        requestTypeId: 61eb2db568c7c300079fefd0
        requesterUserIds:
          - 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-05T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        resolved: 2022-05-05T14:15:22Z'
        requestStatus: RESOLVED
        type: ACCESS_REQUEST
        permalinkId: 1
        _links:
          requestType:
            href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
            type: application/json
    request-list-links:
      type: object
      description: Links available in request list response
      required:
        - self
      properties:
        self:
          $ref: '#/components/schemas/link'
        next:
          $ref: '#/components/schemas/link'
      additionalProperties:
        $ref: '#/components/schemas/link'
    request-list:
      type: object
      properties:
        data:
          description: All requests on the current page
          type: array
          items:
            $ref: '#/components/schemas/request-sparse'
        _links:
          $ref: '#/components/schemas/request-list-links'
    field-id-writable:
      type: string
      description: The `id` of a `requesterField` in the related request type's `requestSettings.requesterFields`
      format: uuid
      maxLength: 36
      minLength: 36
      example: 1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed
    field-date-time-value:
      type: string
      nullable: true
      maxLength: 1000
      format: date-time
      description: Value provided by a user in ISO 8601 string format
    field-select-value-writable:
      type: array
      nullable: true
      minItems: 1
      maxItems: 1
      description: Values provided by a user, only `1` is supported
      items:
        $ref: '#/components/schemas/field-option-value'
    field-text-value:
      type: string
      nullable: true
      minLength: 1
      maxLength: 1000
      description: Value provided by a user
    field-value-writable-allowed-values:
      anyOf:
        - $ref: '#/components/schemas/field-date-time-value'
        - $ref: '#/components/schemas/field-select-value-writable'
        - $ref: '#/components/schemas/field-text-value'
    field-value-writable:
      type: object
      description: |
        An `id` and `value` that corresponds to the `id` of a field in the request type's `requestSettings.requesterFields`.

        If the `id` corresponds to a `DATE-TIME` field, the value must be an `ISO-8601` date-time.
        If the `id` corresponds to a `SELECT` field, the value must be an array of strings where each string is a value from the select field's options.
        If the `id` corresponds to a `TEXT` field, the value must be a string.

        Only provide the field `id` once. Duplicates result in a `409 Conflict` response.

        A non-required field may be omitted from the list.
      required:
        - id
        - value
      properties:
        id:
          $ref: '#/components/schemas/field-id-writable'
        value:
          $ref: '#/components/schemas/field-value-writable-allowed-values'
    requester-field-values-writable:
      type: array
      description: |
        Field values provided when adding the request.

        If a request type has required `requesterFields`, they must be provided when the request is created.

        Non-required fields may be omitted when creating the request.
      items:
        $ref: '#/components/schemas/field-value-writable'
    request-creatable-only:
      type: object
      properties:
        requesterFieldValues:
          $ref: '#/components/schemas/requester-field-values-writable'
    request-creatable:
      type: object
      description: The properties expected in an initial create request
      required:
        - requestTypeId
        - subject
      allOf:
        - $ref: '#/components/schemas/request-mutable'
        - $ref: '#/components/schemas/request-creatable-only'
      example:
        subject: Requesting access to salesforce-01 for my team member
        requesterUserIds:
          - 00ub0oNGTSWTBKOLGLNR
    request-full-api-compatible:
      type: object
      description: Full representation of a Request resource.
      allOf:
        - $ref: '#/components/schemas/read-only-standard-properties'
        - $ref: '#/components/schemas/request-mutable'
        - $ref: '#/components/schemas/request-minimal-read-only-fields'
      required:
        - type
        - id
        - created
        - createdBy
        - subject
        - requestTypeId
        - lastUpdated
        - lastUpdatedBy
        - resolved
        - requestStatus
        - requesterUserIds
        - requesterFieldValues
        - approvals
        - actions
        - permalinkId
        - _links
      properties:
        approvals:
          type: array
          description: Request approvals
          items:
            $ref: '#/components/schemas/request-approval'
        actions:
          $ref: '#/components/schemas/request-actions'
        permalinkId:
          $ref: '#/components/schemas/request-permalink-id'
        type:
          description: This request is associated with a request type with no `CUSTOM` settings.
          type: string
          enum:
            - ACCESS_REQUEST
    request-full-api-incompatible:
      type: object
      description: A Request where the request type has a CUSTOM setting. This representation is limited and does not contain `actions` and `approvals`.
      allOf:
        - $ref: '#/components/schemas/read-only-standard-properties'
        - $ref: '#/components/schemas/request-mutable'
        - $ref: '#/components/schemas/request-minimal-read-only-fields'
      required:
        - type
        - id
        - created
        - createdBy
        - subject
        - requestTypeId
        - lastUpdated
        - lastUpdatedBy
        - resolved
        - requestStatus
        - requesterUserIds
        - requesterFieldValues
        - permalinkId
        - _links
      properties:
        permalinkId:
          $ref: '#/components/schemas/request-permalink-id'
        type:
          description: This request is associated with a request type with `CUSTOM` settings.
          type: string
          enum:
            - CUSTOM
    request-request-type-id:
      type: string
      description: The Request Type enabling this Request.
      maxLength: 24
      minLength: 24
      pattern: ^[a-fA-F\d]{24}$
      format: request-type-id
      example: 05ab2db568c7c300079fefd0
    base-field-value:
      type: object
      description: The field value provided by the user
      required:
        - required
        - prompt
        - id
      properties:
        id:
          $ref: '#/components/schemas/field-id'
        prompt:
          $ref: '#/components/schemas/field-prompt'
        required:
          $ref: '#/components/schemas/field-required'
    field-value-date:
      type: object
      allOf:
        - $ref: '#/components/schemas/base-field-value'
      required:
        - id
        - type
        - value
      properties:
        type:
          $ref: '#/components/schemas/field-date-time-type'
        value:
          $ref: '#/components/schemas/field-date-time-value'
    field-select-value:
      type: array
      nullable: true
      minItems: 1
      maxItems: 1
      description: Values provided by a user, only `1` is supported
      items:
        $ref: '#/components/schemas/field-option-value'
    field-value-select:
      type: object
      allOf:
        - $ref: '#/components/schemas/base-field-value'
      required:
        - id
        - type
        - value
      properties:
        type:
          $ref: '#/components/schemas/field-select-type'
        value:
          $ref: '#/components/schemas/field-select-value'
      example:
        type: SELECT
        prompt: Indicate business justification
        value:
          - REQUIRED for job duties
    field-value-text:
      type: object
      allOf:
        - $ref: '#/components/schemas/base-field-value'
      required:
        - id
        - type
        - value
      properties:
        type:
          $ref: '#/components/schemas/field-text-type'
        value:
          $ref: '#/components/schemas/field-text-value'
    field-value:
      description: The field value provided by the user
      oneOf:
        - $ref: '#/components/schemas/field-value-date'
        - $ref: '#/components/schemas/field-value-select'
        - $ref: '#/components/schemas/field-value-text'
      discriminator:
        propertyName: type
        mapping:
          DATE-TIME: '#/components/schemas/field-value-date'
          SELECT: '#/components/schemas/field-value-select'
          TEXT: '#/components/schemas/field-value-text'
    requester-field-values:
      type: array
      nullable: true
      description: |
        Field values provided when adding the request.

        If a request type has required `requesterFields`, they must be provided when the request is created.

        Non-required fields may be omitted when creating the request.
      items:
        $ref: '#/components/schemas/field-value'
    request-minimal-read-only-fields:
      type: object
      description: Properties contained by default in sparse representation
      properties:
        requestStatus:
          $ref: '#/components/schemas/request-request-status'
        requestTypeId:
          $ref: '#/components/schemas/request-request-type-id'
        resolved:
          $ref: '#/components/schemas/request-resolved-date-time'
        requesterFieldValues:
          $ref: '#/components/schemas/requester-field-values'
        _links:
          $ref: '#/components/schemas/request-links'
    request-approval-id:
      type: string
      maxLength: 24
      minLength: 24
      pattern: ^[a-fA-F\d]{24}$
      format: approval-id
      description: A unique identifier of the approval in the request
    request-approval-pending:
      type: object
      description: A pending access request approval
      required:
        - status
        - approvalId
      properties:
        status:
          type: string
          description: The status of a pending approval
          enum:
            - PENDING
        approvalId:
          $ref: '#/components/schemas/request-approval-id'
      example:
        requestStatus: OPEN
    approval-field-values:
      type: array
      description: |-
        Values to field prompts provided by the approver at the time of approval.

        All approval fields specified in the related request type are represented in the same order as defined in the request type.
      nullable: true
      items:
        $ref: '#/components/schemas/field-value'
    request-approval-completed:
      type: object
      description: A completed access request approval
      required:
        - status
        - approverName
        - approvalId
        - approverId
        - decision
        - decided
        - fieldValues
      properties:
        status:
          type: string
          description: The status of a completed approval
          enum:
            - COMPLETED
        approverName:
          type: string
          description: Okta username of the user which approved the request
          maxLength: 100
        approvalId:
          $ref: '#/components/schemas/request-approval-id'
        approverId:
          type: string
          format: okta-user-id
          description: Okta User.id of the user which approved the request
          maxLength: 20
          minLength: 20
          pattern: 00u[0-9a-zA-Z]+
        decision:
          type: string
          enum:
            - APPROVED
            - DENIED
        decided:
          type: string
          format: date-time
          description: The date the approver made their decision.
        originalDeciderId:
          $ref: '#/components/schemas/user-id'
        originalDeciderFullName:
          type: string
          description: Full name of the original decider
          maxLength: 100
        originalDeciderEmail:
          type: string
          description: Email of the original decider
          format: email
        deciderDelegated:
          type: boolean
          description: Indicates if the decision was made by a delegated decider
        deciderEscalated:
          type: boolean
          description: Indicates if the decision was made by an escalated decider
        fieldValues:
          $ref: '#/components/schemas/approval-field-values'
      example:
        status: COMPLETED
        approverId: 00ub0oNGTSWTBKOLGLNR
        decision: APPROVED
        decided: '2022-06-02T21:36:25.344Z'
        fieldValues:
          - type: SELECT
            value:
              - value: Curious
    request-approval:
      type: object
      description: An approval for this request. It may be in a PENDING or COMPLETED state.
      oneOf:
        - $ref: '#/components/schemas/request-approval-pending'
        - $ref: '#/components/schemas/request-approval-completed'
      discriminator:
        propertyName: status
        mapping:
          PENDING: '#/components/schemas/request-approval-pending'
          COMPLETED: '#/components/schemas/request-approval-completed'
    request-action-enum:
      type: string
      description: The type of action taken by the access request service to fulfill the request.
      x-okta-known-values:
        - ADD_USER_TO_GROUP
        - ASSIGN_APP_TO_USER
        - GRANT_ACCESS_TO_ENTITLEMENT_BUNDLE
    request-action-id:
      type: string
      maxLength: 24
      minLength: 24
      pattern: ^[a-fA-F\d]{24}$
      format: action-id
      description: A unique identifier of the action taken in the request
    request-action-pending:
      type: object
      description: A pending action, approvals still required
      required:
        - status
        - action
        - actionId
      properties:
        status:
          type: string
          description: The status of a pending action
          enum:
            - PENDING
        action:
          $ref: '#/components/schemas/request-action-enum'
        actionId:
          $ref: '#/components/schemas/request-action-id'
      example:
        status: PENDING
    resource-id:
      type: string
      format: okta-resource-id
      description: |
        The Okta `app.id` or `group.id` of the resource that can be requested with this request type.

        * See [List all applications](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/application/other/listapplications) to retrieve app IDs.
        * See [List all groups](https://developer.okta.com/docs/api/openapi/okta-management/management/tags/group/other/listgroups) to retrieve group IDs.
      maxLength: 20
    okta-resource-readable:
      type: object
      description: Identifies a unique Okta resource
      properties:
        resourceName:
          type: string
          description: Human readable name of the resource
        resourceId:
          $ref: '#/components/schemas/resource-id'
        resourceType:
          type: string
          enum:
            - APP
            - GROUP
            - ENTITLEMENT_BUNDLE
          description: The type of resource
    request-action-completed:
      type: object
      description: A completed access request approval
      required:
        - status
        - action
        - actionId
        - actionStatus
        - actionAttempted
        - resourceId
        - resourceName
        - resourceType
      allOf:
        - $ref: '#/components/schemas/okta-resource-readable'
      properties:
        status:
          type: string
          description: The status of a completed approval
          enum:
            - COMPLETED
        action:
          $ref: '#/components/schemas/request-action-enum'
        actionId:
          $ref: '#/components/schemas/request-action-id'
        actionStatus:
          type: string
          enum:
            - SUCCEEDED
            - FAILED
          description: Whether the action was successful or not
        actionAttempted:
          type: string
          format: date-time
          description: When the action was attempted
        accessRemoved:
          nullable: true
          type: string
          format: date-time
          description: When access was removed if the associated Request Type has an `accessDuration`. null if the Request Type does not have an `accessDuration`, or the duration has not yet expired.
    request-action:
      type: object
      description: An action taken as part of this request, null if there will never be actions for this request.
      oneOf:
        - $ref: '#/components/schemas/request-action-pending'
        - $ref: '#/components/schemas/request-action-completed'
      discriminator:
        propertyName: status
        mapping:
          PENDING: '#/components/schemas/request-action-pending'
          COMPLETED: '#/components/schemas/request-action-completed'
    request-actions:
      type: array
      minItems: 1
      maxItems: 1
      description: A list of actions. Currently only supports one action per request.
      nullable: true
      items:
        $ref: '#/components/schemas/request-action'
    request-full:
      type: object
      description: A full representation of a request
      discriminator:
        propertyName: type
        mapping:
          ACCESS_REQUEST: '#/components/schemas/request-full-api-compatible'
          CUSTOM: '#/components/schemas/request-full-api-incompatible'
      oneOf:
        - $ref: '#/components/schemas/request-full-api-compatible'
        - $ref: '#/components/schemas/request-full-api-incompatible'
    request-message-message:
      type: string
      description: Message that will be created for the request. Newline can be specified by characters "\n". Message will be visible for all users who can view the request.
      minLength: 1
      maxLength: 5000
      nullable: false
    request-message-mutable:
      type: object
      required:
        - message
      properties:
        message:
          $ref: '#/components/schemas/request-message-message'
    request-message-creatable:
      type: object
      description: The properties expected in a request message create request
      allOf:
        - $ref: '#/components/schemas/request-message-mutable'
    team-id:
      type: string
      description: Team ID
      maxLength: 24
      minLength: 24
      pattern: ^[a-fA-F\d]{24}$
      format: owner-id
    team-name:
      type: string
      description: The name of the team
      maxLength: 40
      minLength: 1
    team:
      type: object
      required:
        - id
        - created
        - lastUpdated
        - name
      properties:
        id:
          $ref: '#/components/schemas/team-id'
        created:
          description: The ISO 8601 formatted date and time when the resource was created
          type: string
          format: date-time
          readOnly: true
        lastUpdated:
          $ref: '#/components/schemas/last-updated'
        name:
          $ref: '#/components/schemas/team-name'
    teams-list-links:
      type: object
      description: Links available in teams response
      required:
        - self
      properties:
        self:
          $ref: '#/components/schemas/link'
        next:
          $ref: '#/components/schemas/link'
      additionalProperties:
        $ref: '#/components/schemas/link'
    teams-list:
      type: object
      properties:
        data:
          description: All teams on the current page
          type: array
          items:
            $ref: '#/components/schemas/team'
        _links:
          $ref: '#/components/schemas/teams-list-links'
  parameters:
    request-types-list-filter:
      name: filter
      description: |
        Apply various filters by using supported request types filtering properties.

        **Note:** Query parameter percent encoding is required. See [Percent-encoding](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding)
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/scim-filter'
      x-scim-filter:
        status:
          operators:
            - eq
          schema:
            $ref: '#/components/schemas/request-type-status'
        lastUpdated:
          operators:
            - gt
          schema:
            $ref: '#/components/schemas/last-updated'
      examples:
        FilterByStatus:
          summary: Filter by status
          value: status eq "ACTIVE"
        FilterByLastUpdated:
          summary: Filter by lastUpdated
          value: lastUpdated gt "2022-05-24T14:15:22Z"
        FilterByStatusAndLastUpdated:
          summary: Filter by status and lastUpdated
          value: status eq "ACTIVE" AND lastUpdated gt "2022-05-24T14:15:22Z"
    request-types-list-after:
      name: after
      description: The after cursor provided by a prior request.
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/request-type-id'
    limit:
      name: limit
      description: The maximum number of records returned in a response
      in: query
      required: false
      schema:
        type: integer
        default: 20
        maximum: 200
        minimum: 1
    request-types-list-order-by:
      name: orderBy
      description: |
        Apply an ordering of request types by specifying a supported request type property name with `%20asc` or `%20desc` suffix.

        **Note:** Query parameter percent encoding is required. See [Percent-encoding](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding)
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/order-by'
      x-order-by:
        attributes:
          - created
          - lastUpdated
      examples:
        OrderByCreated:
          summary: Order by created
          value: created desc
        OrderByLastUpdated:
          summary: Order by lastUpdated
          value: lastUpdated desc
    request-type-id:
      name: requestTypeId
      description: Unique identifier for the request type
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/request-type-id'
    request-list-filter:
      name: filter
      description: |
        Apply various filters by using supported request filtering properties.

        **Note:** Query parameter percent encoding is required. See [Percent-encoding](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding)
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/scim-filter'
      x-scim-filter:
        requestStatus:
          operators:
            - eq
          schema:
            $ref: '#/components/schemas/request-request-status'
        lastUpdated:
          operators:
            - gt
          schema:
            $ref: '#/components/schemas/last-updated'
      examples:
        FilterByRequestStatus:
          summary: Filter by requestStatus
          value: requestStatus eq "RESOLVED"
        FilterByLastUpdated:
          summary: Filter by lastUpdated
          value: lastUpdated gt "2022-05-24T14:15:22Z"
        FilterByRequestStatusAndLastUpdated:
          summary: Filter by requestStatus and lastUpdated
          value: requestStatus eq "RESOLVED" AND lastUpdated gt "2022-05-24T14:15:22Z"
    request-list-after:
      name: after
      description: The after cursor provided by a prior request.
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/request-id'
    request-list-order-by:
      name: orderBy
      description: |
        Apply an ordering of requests by specifying a supported request property name with `%20asc` or `%20desc` suffix.

        **Note:** Query parameter percent encoding is required. See [Percent-encoding](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding)
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/order-by'
      x-order-by:
        attributes:
          - created
          - lastUpdated
      examples:
        OrderByCreated:
          summary: Order by created
          value: created desc
        OrderByLastUpdated:
          summary: Order by lastUpdated
          value: lastUpdated desc
    request-id:
      name: requestId
      description: Unique identifier for the request
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/request-id'
    teams-filter:
      name: filter
      description: |
        Apply various filters by using supported team filtering properties.

        **Note:** Query parameter percent encoding is required. See [Percent-encoding](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding)
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/scim-filter'
      x-scim-filter:
        name:
          operators:
            - eq
          schema:
            $ref: '#/components/schemas/team-name'
      examples:
        FilterByName:
          summary: Filter by name
          value: name eq "Salesforce admins"
    teams-after:
      name: after
      description: The after cursor provided by a prior request.
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/team-id'
  headers:
    link:
      required: false
      description: |-
        A link to `self` and `next`.
        > **Note:** `next` is only present if there's another page of results.
      schema:
        type: string
    rate-limit-limit:
      required: true
      description: The rate-limit ceiling for the current request
      schema:
        type: integer
        minimum: 1
        example: 60
    rate-limit-remaining:
      required: true
      description: The number of requests left for the current rate-limit window
      schema:
        type: integer
        minimum: 0
        example: 60
    rate-limit-reset:
      required: true
      description: The time when the rate limit resets, specified in UTC epoch time (in seconds)
      schema:
        type: integer
        minimum: 0
        example: 1609459200
  examples:
    request-types-list-no-filter:
      summary: List request types response with no filter
      description: A list of request type with no filter
      value:
        data:
          - id: 08ab2db568c7c300079fefd
            name: low-privilege-group-01-request-type-02
            description: How users can request access to low privilege Group 01
            created: '2022-05-24T14:15:22Z'
            createdBy: 00ub0oNGTSWTBKOLGLNR
            lastUpdated: '2022-05-24T14:15:22Z'
            lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
            status: DRAFT
            lastUpdateSource: API
            _links:
              createRequest:
                href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=08ab2db568c7c300079fefd0
                type: text/html
              requests:
                href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2208ab2db568c7c300079fefd0%22
              self:
                href: https://myorg.okta.com/governance/api/v1/request-types/08ab2db568c7c300079fefd0
          - id: 10ab2db568c7c300079fefd
            name: salesforce-01-request-type-07
            description: How anyone can request access to Salesforce 01
            created: '2022-05-24T14:15:22Z'
            createdBy: 00ub0oNGTSWTBKOLGLNR
            lastUpdated: '2022-05-24T14:15:22Z'
            lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
            status: DRAFT
            lastUpdateSource: API
            _links:
              createRequest:
                href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=10ab2db568c7c300079fefd0
                type: text/html
              requests:
                href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2210ab2db568c7c300079fefd0%22
              self:
                href: https://myorg.okta.com/governance/api/v1/request-types/10ab2db568c7c300079fefd0
          - id: 07ab2db568c7c300079fefd0
            name: low-privilege-group-01-request-type-01
            description: How users can request access to low privilege Group 01
            created: '2022-05-24T14:15:22Z'
            createdBy: 00ub0oNGTSWTBKOLGLNR
            lastUpdated: '2022-05-24T14:15:22Z'
            lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
            status: DRAFT
            lastUpdateSource: API
            _links:
              createRequest:
                href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=07ab2db568c7c300079fefd0
                type: text/html
              requests:
                href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2207ab2db568c7c300079fefd0%22
              self:
                href: https://myorg.okta.com/governance/api/v1/request-types/07ab2db568c7c300079fefd0
          - id: 01ab2db568c7c300079fefd0
            name: salesforce-01-request-type-01
            description: How users can get manager's approval to access Salesforce 01
            created: '2022-05-24T14:15:22Z'
            createdBy: 00ub0oNGTSWTBKOLGLNR
            lastUpdated: '2022-05-24T14:15:22Z'
            lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
            status: DRAFT
            lastUpdateSource: API
            _links:
              createRequest:
                href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=01ab2db568c7c300079fefd0
                type: text/html
              requests:
                href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2201ab2db568c7c300079fefd0%22
              self:
                href: https://myorg.okta.com/governance/api/v1/request-types/01ab2db568c7c300079fefd0
          - id: 04ab2db568c7c300079fefd0
            name: salesforce-01-request-type-04
            description: How users can request access to Salesforce 01, approving manager must select justification
            created: '2022-05-24T14:15:22Z'
            createdBy: 00ub0oNGTSWTBKOLGLNR
            lastUpdated: '2022-05-24T14:15:22Z'
            lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
            status: DRAFT
            lastUpdateSource: API
            _links:
              createRequest:
                href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=04ab2db568c7c300079fefd0
                type: text/html
              requests:
                href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2204ab2db568c7c300079fefd0%22
              self:
                href: https://myorg.okta.com/governance/api/v1/request-types/04ab2db568c7c300079fefd0
          - id: 03ab2db568c7c300079fefd0
            name: salesforce-01-request-type-03
            description: How users can request access to Salesforce 01 and provide text input
            created: '2022-05-24T14:15:22Z'
            createdBy: 00ub0oNGTSWTBKOLGLNR
            lastUpdated: '2022-05-24T14:15:22Z'
            lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
            status: DRAFT
            lastUpdateSource: API
            _links:
              createRequest:
                href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=03ab2db568c7c300079fefd0
                type: text/html
              requests:
                href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2203ab2db568c7c300079fefd0%22
              self:
                href: https://myorg.okta.com/governance/api/v1/request-types/03ab2db568c7c300079fefd0
          - id: 05ab2db568c7c300079fefd0
            name: salesforce-01-request-type-05
            description: How users can request access to Salesforce 01, approving manager must approve and answer a question using a DATE-TIME field
            created: '2022-05-24T14:15:22Z'
            createdBy: 00ub0oNGTSWTBKOLGLNR
            lastUpdated: '2022-05-24T14:15:22Z'
            lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
            status: DRAFT
            lastUpdateSource: API
            _links:
              createRequest:
                href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=05ab2db568c7c300079fefd0
                type: text/html
              requests:
                href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2205ab2db568c7c300079fefd0%22
              self:
                href: https://myorg.okta.com/governance/api/v1/request-types/05ab2db568c7c300079fefd0
          - id: 06ab2db568c7c300079fefd0
            name: admin-group-01-request-type-01
            description: How users can request access to Admin Group 01, with multiple approvals, where each approval demonstrates a different way to specify the approver.
            created: '2022-05-24T14:15:22Z'
            createdBy: 00ub0oNGTSWTBKOLGLNR
            lastUpdated: '2022-05-24T14:15:22Z'
            lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
            status: DRAFT
            lastUpdateSource: API
            _links:
              createRequest:
                href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=06ab2db568c7c300079fefd0
                type: text/html
              requests:
                href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2206ab2db568c7c300079fefd0%22
              self:
                href: https://myorg.okta.com/governance/api/v1/request-types/06ab2db568c7c300079fefd0
          - id: 09ab2db568c7c300079fefd0
            name: salesforce-01-request-type-06
            description: How users can request access to Salesforce 01
            created: '2022-05-24T14:15:22Z'
            createdBy: 00ub0oNGTSWTBKOLGLNR
            lastUpdated: '2022-05-24T14:15:22Z'
            lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
            status: DRAFT
            lastUpdateSource: API
            _links:
              createRequest:
                href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=09ab2db568c7c300079fefd0
                type: text/html
              requests:
                href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2209ab2db568c7c300079fefd0%22
              self:
                href: https://myorg.okta.com/governance/api/v1/request-types/09ab2db568c7c300079fefd0
          - id: 12ab2db568c7c300079fefd0
            name: salesforce-01-request-type-09
            description: How group members can request access to Salesforce 01
            created: '2022-05-24T14:15:22Z'
            createdBy: 00ub0oNGTSWTBKOLGLNR
            lastUpdated: '2022-05-24T14:15:22Z'
            lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
            status: DRAFT
            lastUpdateSource: API
            _links:
              createRequest:
                href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=12ab2db568c7c300079fefd0
                type: text/html
              requests:
                href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2212ab2db568c7c300079fefd0%22
              self:
                href: https://myorg.okta.com/governance/api/v1/request-types/12ab2db568c7c300079fefd0
        _links:
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types?limit=20
    empty-after:
      summary: Empty `after` parameter error response
      description: A request contains the `after` query parameter but it's empty (?after=)
      value:
        errorCode: E0000029
        errorSummary: Invalid paging request
        errorLink: E0000029
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: Empty value found for query parameter 'after'
            reason: EMPTY_PARAMETER
            locationType: query
            location: /after
            domain: governance
    request-types-list-bad-request-invalid-after:
      summary: When after parameter is invalid format
      description: When after query parameter value is invalid format (?after=1)
      value:
        errorCode: E0000029
        errorSummary: Invalid paging request.
        errorLink: E0000029
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: must NOT have fewer than 24 characters
            reason: INVALID_STRING_LENGTH_UNDER_MIN
            locationType: query
            location: /after
          - domain: governance
            errorSummary: must match pattern "^[a-fA-F\\d]{24}$"
            reason: STRING_FORMAT_INVALID
            locationType: query
            location: /after
          - domain: governance
            errorSummary: must be a request type id
            reason: STRING_FORMAT_INVALID
            locationType: query
            location: /after
    request-types-list-bad-request-not-exist-after:
      summary: When after parameter value not found
      description: When a request contains after query parameter with request type ID that does not exist
      value:
        errorCode: E0000029
        errorSummary: Invalid paging request.
        errorLink: E0000029
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: 08ab2db568c7c300079fefd0 not found
            reason: IDENTIFIER_NOT_FOUND
            locationType: query
            location: /after
            domain: governance
    invalid-sort:
      summary: Invalid `orderBy` parameter error response
      description: Invalid `orderBy` parameter error response
      value:
        errorCode: E0000029
        errorSummary: Invalid paging request
        errorLink: E0000029
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: Invalid `orderBy` syntax
            reason: STRING_FORMAT_INVALID
            locationType: query
            location: /orderBy
            domain: governance
    invalid-limit:
      summary: Invalid `limit` parameter error response
      description: Invalid `limit` parameter error response
      value:
        errorCode: E0000029
        errorSummary: Invalid paging request
        errorLink: E0000029
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: The `limit` parameter isn't valid.
            reason: INVALID_DATA_TYPE
            locationType: query
            location: /limit
            domain: governance
    request-type-creatable-00-minimal-example:
      summary: For access to group, has minimal required properties
      description: The minimal set of properties to pass when creating a Request Type. Allows anyone to request access to the Admin Group. No questions are required, and there is only one approval required by the requesting user's manager.
      value:
        name: salesforce-01
        description: How users can request access to Admin Group
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: GROUPS
          targetResources:
            - resourceId: 00g1emaKYZTWRYYRRTSK
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
    request-type-creatable-01-request-anyone-no-questions-example:
      summary: For access to app, includes defaults
      description: When request type is for access to app and includes defaults
      value:
        name: salesforce-01-request-type
        description: How users can request access to Salesforce 01
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        requestSettings:
          type: EVERYONE
          requesterFields: []
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
    request-type-creatable-02-group-manager-example:
      summary: For access to group, requires manager's approval
      description: Creating a request type to enable requests for access to a group
      value:
        name: admin-group-01
        description: How users can request access to Admin Group
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: GROUPS
          targetResources:
            - resourceId: 00g1emaKYZTWRYYRRTSK
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
    request-type-creatable-03-app-manager-example:
      summary: For access to app, manager's approval required
      description: Creating a request type to enable requests for access to an application
      value:
        name: salesforce-01-request-type
        description: How users can request access to Salesforce 01
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
    request-type-creatable-04-app-manager-select-field-example:
      summary: Approver fields with select input
      description: Creating a Request Type where anyone may request access. The requester's manager needs to approve and select an option.
      value:
        name: salesforce-01-request-type
        description: How users can request access to Salesforce 01
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              approverFields:
                - prompt: What is the justification for granting access?
                  required: true
                  type: SELECT
                  options:
                    - value: Required to perform job duties
                    - value: Required to perform one time task
    request-type-creatable-05-app-manager-text-field-example:
      summary: Manager approver field specifies text defaults explicitly
      description: Creating a request type where anyone may request access. The requester's manager needs to approve and must provide value for text field.
      value:
        name: salesforce-01-request-type
        description: How users can request access to Salesforce 01
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              approverFields:
                - prompt: What is the business justification for your employee's access?
                  required: true
                  type: TEXT
    request-type-creatable-06-app-manager-datetime-field-example:
      summary: Manager approver has required date-time field
      description: Creating a request type where anyone may request access. The requester's manager needs to approve and must provide value for date-time field.
      value:
        name: salesforce-01-request-type
        description: How users can request access to Salesforce 01
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              approverFields:
                - prompt: What time should access be revoked?
                  required: true
                  type: DATE-TIME
    request-type-creatable-07-approval-multi-step-example:
      summary: Multi-step approvals, one of each type
      description: Payload for creating a request type with many approvals. Anyone can request access to the group. No questions need to be answered. First their manager's approval is required. Second a member of a group's approval is required. And finally a specific user's approval is required.
      value:
        name: salesforce-01
        description: How users can request access to Admin Group
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: GROUPS
          targetResources:
            - resourceId: 00g1emaKYZTWRYYRRTSK
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
            - approverType: MEMBER_OF
              approverMemberOf:
                - 00garwpuyxHaWOkdV0g4
            - approverType: USER
              approverUserId: 00ub0oNGTSWTBKOLGLNR
    request-type-creatable-08-optional-questions-example:
      summary: Optional requester field
      description: When a requester field is optional. **Note** approverFields always required if present.
      value:
        name: salesforce-01-request-type
        description: How users can request access to Salesforce 01
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        requestSettings:
          type: EVERYONE
          requesterFields:
            - prompt: Why are you requesting access?
              type: TEXT
              required: false
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              approverFields:
                - prompt: Why are you approving access?
                  type: TEXT
                  required: true
    request-type-creatable-09-requester-memberof-example:
      summary: Requester must be member of a group
      description: Creating a request type where only members of a group may request access to the application.
      value:
        name: salesforce-01-request-type
        description: How users can request access to Salesforce 01
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        requestSettings:
          type: MEMBER_OF
          requesterMemberOf:
            - 00garwpuyxHaWOkdV0g4
          requesterFields:
            - prompt: What is the business justification for access?
              type: TEXT
              required: true
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
    request-type-creatable-10-active-example:
      summary: An active request type with time bound access
      description: A request type created with active status where all requests will only grant access for a limited duration of time.
      value:
        name: salesforce-01
        description: How users can request access to Admin Group
        ownerId: 61eb0f06c462d20007f051ac
        status: ACTIVE
        accessDuration: P40D
        resourceSettings:
          type: GROUPS
          targetResources:
            - resourceId: 00g1emaKYZTWRYYRRTSK
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
    request-type-creatable-11-no-approval-example:
      summary: A request type that requires no approval
      description: |
        Create a request type that allows anyone to request access to Grammarly.  No questions are required, and no approvals are required.
      value:
        name: Request for Grammarly
        description: A request type that allows a user to request access to Grammarly
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        approvalSettings:
          type: NONE
    request-type-creatable-12-approval-description-example:
      summary: A request type requiring an approval that has a description
      description: |
        Create a request type that allows anyone to request access to Tableau.  No questions are required, and no approvals are required.
      value:
        name: Request for Tableau
        description: A request type that allows a user to request access to Tableau
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: USER
              description: Approval from Data Analytics Team Head - Stan Lee
              approverUserId: 00ub0oNGTSWTBKOLGLNR
    request-type-creatable-13-resource-owner-approval-example:
      summary: A request type requiring resource owner approval
      description: |
        Create a request type that requires approval from the owner of the resource
      value:
        name: Request for Group
        description: A request type that requires approval from the owner of the group
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: GROUPS
          targetResources:
            - resourceId: 00g1emaKYZTWRYYRRTSK
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: RESOURCE_OWNER
    request-type-creatable-00-minimal-full-example:
      summary: When request type is for groups, has minimal required properties
      description: The minimal set of properties to pass when creating a Request Type. Allows anyone to request access to the Admin Group. No questions are required, and there is only one approval required by the requesting user's manager.
      value:
        id: 08ab2db568c7c300079fefd0
        name: low-privilege-group-01-request-type-02
        description: How users can request access to low privilege Group 01
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: GROUPS
          targetResources:
            - resourceId: 00g1emaKYZTWRYYRRTSK
              resourceName: Low privilege Group 01
        requestSettings:
          type: EVERYONE
          requesterFields: []
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              description: Approval from the requester's manager
              approverFields: []
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=08ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2208ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/08ab2db568c7c300079fefd0
    request-type-creatable-01-request-anyone-no-questions-full-example:
      summary: For access to app, includes defaults
      description: Creating a request type and anyone may request it and not using default.
      value:
        id: 10ab2db568c7c300079fefd0
        name: salesforce-01-request-type-07
        description: How anyone can request access to Salesforce 01
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        requestSettings:
          type: EVERYONE
          requesterFields: []
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              description: Approval from the requester's manager
              approverFields: []
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=10ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2210ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/10ab2db568c7c300079fefd0
    request-type-creatable-02-group-manager-full-example:
      summary: For access to group, manager's approval required
      description: Creating a request type to enable requests for access to a group
      value:
        id: 07ab2db568c7c300079fefd0
        name: low-privilege-group-01-request-type-01
        description: How users can request access to low privilege Group 01
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: GROUPS
          targetResources:
            - resourceId: 00g1emaKYZTWRYYRRTSK
              resourceName: Low privilege Group 01
        requestSettings:
          type: EVERYONE
          requesterFields: []
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              description: Approval from the requester's manager
              approverFields: []
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=07ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2207ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/07ab2db568c7c300079fefd0
    request-type-creatable-03-app-manager-full-example:
      summary: For access to app, manager's approval required
      description: Creating a request type to enable requests for access to an application
      value:
        id: 01ab2db568c7c300079fefd0
        name: salesforce-01-request-type-01
        description: How users can get manager's approval to access Salesforce 01
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        requestSettings:
          type: EVERYONE
          requesterFields: []
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              description: Approval from the requester's manager
              approverFields: []
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=01ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2201ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/01ab2db568c7c300079fefd0
    request-type-creatable-04-app-manager-select-field-full-example:
      summary: Manager approver has required select field
      description: Creating a request type where anyone may request access. The requester's manager needs to approve and select an option.
      value:
        id: 04ab2db568c7c300079fefd0
        name: salesforce-01-request-type-04
        description: How users can request access to Salesforce 01, approving manager must select justification
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        requestSettings:
          type: EVERYONE
          requesterFields: []
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              description: Approval from the requester's manager
              approverFields:
                - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
                  prompt: What is the justification for granting access?
                  required: true
                  type: SELECT
                  options:
                    - value: Required to perform job duties
                    - value: Required to perform one time task
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=04ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2204ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/04ab2db568c7c300079fefd0
    request-type-creatable-05-app-manager-text-field-full-example:
      summary: Manager approver field specifies text defaults explicitly
      description: Full representation of approver text field
      value:
        id: 03ab2db568c7c300079fefd0
        name: salesforce-01-request-type-03
        description: How users can request access to Salesforce 01 and provide text input
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        requestSettings:
          type: EVERYONE
          requesterFields: []
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              description: Approval from the requester's manager
              approverFields:
                - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
                  prompt: What is the business justification for your employee's access?
                  required: true
                  type: TEXT
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=03ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2203ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/03ab2db568c7c300079fefd0
    request-type-creatable-06-app-manager-datetime-field-full-example:
      summary: Manager approver has required date-time field
      description: Payload for creating request type where the requester's manager needs to approve and answer a question using a DATE-TIME field.
      value:
        id: 05ab2db568c7c300079fefd0
        name: salesforce-01-request-type-05
        description: How users can request access to Salesforce 01, approving manager must approve and answer a question using a DATE-TIME field
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        requestSettings:
          type: EVERYONE
          requesterFields: []
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              description: Approval from the requester's manager
              approverFields:
                - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
                  prompt: What time should access be revoked?
                  required: true
                  type: DATE-TIME
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=05ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2205ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/05ab2db568c7c300079fefd0
    request-type-creatable-07-approval-multi-step-full-example:
      summary: Multi-step approvals, one of each type
      description: Payload for creating request type where there are many approval steps, where each step demonstrates a different way to specify who may approve.
      value:
        id: 06ab2db568c7c300079fefd0
        name: admin-group-01-request-type-01
        description: How users can request access to Admin Group 01, with multiple approvals, where each approval demonstrates a different way to specify the approver.
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: GROUPS
          targetResources:
            - resourceId: 00g1emaKYZTWRYYRRTSK
              resourceName: Admin Group 01
        requestSettings:
          type: EVERYONE
          requesterFields: []
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              description: Approval from the requester's manager
              approverFields: []
            - approverType: MEMBER_OF
              description: Approval from a member of the specified OKTA group
              approverMemberOf:
                - 00garwpuyxHaWOkdV0g4
              approverFields: []
            - approverType: USER
              description: Approval from the specified user
              approverUserId: 00ub0oNGTSWTBKOLGLNR
              approverFields: []
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=06ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2206ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/06ab2db568c7c300079fefd0
    request-type-creatable-08-optional-questions-full-example:
      summary: Optional requester field
      description: When a requester field is optional. **Note** approverFields always required if present.
      value:
        id: 09ab2db568c7c300079fefd0
        name: salesforce-01-request-type-06
        description: How users can request access to Salesforce 01
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        requestSettings:
          type: EVERYONE
          requesterFields:
            - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
              type: TEXT
              prompt: Why are you requesting access?
              required: false
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              description: Approval from the requester's manager
              approverFields:
                - id: ec9da40d-9c1b-41c6-8016-edfd010b02d2
                  type: TEXT
                  prompt: Why are you approving access?
                  required: true
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=09ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2209ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/09ab2db568c7c300079fefd0
    request-type-creatable-09-requester-memberof-full-example:
      summary: Requester must be member of a group
      description: Creating a request type where only members of a group may request access to the application.
      value:
        id: 12ab2db568c7c300079fefd0
        name: salesforce-01-request-type-09
        description: How group members can request access to Salesforce 01
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
        requestSettings:
          type: MEMBER_OF
          requesterMemberOf:
            - 00garwpuyxHaWOkdV0g4
          requesterFields:
            - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
              prompt: What is the business justification for access?
              type: TEXT
              required: true
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              description: Approval from the requester's manager
              approverFields: []
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=12ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2212ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/12ab2db568c7c300079fefd0
    request-type-creatable-10-active-full-example:
      summary: An active request type with time bound access
      description: A request type created with active status where all requests will only grant access for a limited duration of time.
      value:
        id: 08ab2db568c7c300079fefd0
        name: low-privilege-group-01-request-type-02
        description: How users can request access to low privilege Group 01
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: ACTIVE
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: GROUPS
          targetResources:
            - resourceId: 00g1emaKYZTWRYYRRTSK
              resourceName: Low privilege Group 01
        requestSettings:
          type: EVERYONE
          requesterFields: []
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MANAGER
              description: Approval from the requester's manager
              approverFields: []
        accessDuration: P40D
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=08ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2208ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/08ab2db568c7c300079fefd0
    request-type-creatable-11-no-approval-full-example:
      summary: A request type that requires no approval
      description: |
        Create a request type that allows anyone to request access to Grammarly.  No questions are required, and no approvals are required.
      value:
        id: 08ab2db568c7c300079fefd0
        name: Request for Grammarly
        description: A request type that allows a user to request access to Grammarly
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
              resourceName: Grammarly
        requestSettings:
          type: EVERYONE
          requesterFields: []
        approvalSettings:
          type: NONE
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20for%20Grammarly&request_type=08ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2208ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/08ab2db568c7c300079fefd0
    request-type-creatable-12-approval-description-full-example:
      summary: A request type requiring an approval that has a description
      description: |
        Create a request type that allows anyone to request access to Tableau.  No questions are required, and no approvals are required.
      value:
        id: 08ab2db568c7c300079fefd0
        name: Request for Tableau
        description: A request type that allows a user to request access to Tableau
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: APPS
          targetResources:
            - resourceId: 0oafxqCAJWWGELFTYASJ
              resourceName: Tableau
        requestSettings:
          type: EVERYONE
          requesterFields: []
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: USER
              description: Approval from Data Analytics Team Head - Stan Lee
              approverUserId: 00ub0oNGTSWTBKOLGLNR
              approverFields: []
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20for%20Tableau&request_type=08ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2208ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/08ab2db568c7c300079fefd0
    request-type-creatable-13-resource-owner-approval-full-example:
      summary: A request type requiring resource owner approval
      description: |
        Create a request type that requires approval from the owner of the resource
      value:
        id: 08ab2db568c7c300079fefd0
        name: Request for Group
        description: A request type that requires approval from the owner of the group
        created: '2022-05-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        lastUpdateSource: API
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: GROUPS
          targetResources:
            - resourceId: 00g1emaKYZTWRYYRRTSK
              resourceName: Low privilege Group 01
        requestSettings:
          type: EVERYONE
          requesterFields: []
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: RESOURCE_OWNER
              description: Approval from the resource owner
              approverFields: []
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20for%20Group&request_type=08ab2db568c7c300079fefd0
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2208ab2db568c7c300079fefd0%22
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/08ab2db568c7c300079fefd0
    requester-memberOf-invalid-group-id:
      summary: When requesterMemberOf contains an not found Okta Group id
      description: When /requestSettings/requesterMemberOf/0 contains a groupId that is not discoverable in your Okta organization.
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requestSettings/requesterMemberOf/0 00g1emaKYZTWRYYRRTWX not found'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: 00g1emaKYZTWRYYRRTWX not found
            reason: IDENTIFIER_NOT_FOUND
            locationType: body
            location: /requestSettings/requesterMemberOf/0
            domain: governance
    approval-memberOf-too-many-group-ids:
      summary: When too many Okta groupIds are included in approverMemberOf
      description: When too many Okta groupIds are included in /approvalSettings/approvals/0/approverMemberOf/0
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /approvalSettings/approvals/0/approverMemberOf/0 must NOT have more than 1 items'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: must NOT have more than 1 items
            reason: INVALID_ARRAY_LENGTH_OVER_MAX
            locationType: body
            location: /approvalSettings/approvals/0/approverMemberOf/0
            domain: governance
    approval-missing-memberOf:
      summary: When required /requestSettings/requesterMemberOf is missing
      description: When required /requestSettings/requesterMemberOf is missing
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requestSettings/requesterMemberOf must have required property ''requesterMemberOf'''
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: must have required property 'requesterMemberOf'
            reason: REQUIRED_PROPERTY_MISSING
            locationType: body
            location: /requestSettings/requesterMemberOf
            domain: governance
    fieldOptions-label-value-too-long:
      summary: When SELECT option value exceeds max length
      description: When /requestSettings/requesterFields/0/options/0/value exceeds max length
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requestSettings/requesterFields/0/options/0/value must NOT have more than 280 characters'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: must NOT have more than 280 characters
            reason: INVALID_STRING_LENGTH_OVER_MAX
            locationType: body
            location: /requestSettings/requesterFields/0/options/0/value
            domain: governance
    fieldOptions-missing:
      summary: When SELECT options are missing
      description: When /requestSettings/requesterFields/0/options is missing
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requestSettings/requesterFields/0/options must have required property ''options'''
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: must have required property 'options'
            reason: REQUIRED_PROPERTY_MISSING
            locationType: body
            location: /requestSettings/requesterFields/0/options
            domain: governance
    approver-fields-type-invalid:
      summary: When approver field type is invalid
      description: When approver field type is invalid
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /approvalSettings/approvals/0/approverFields/0/ must be equal to one of the allowed values: SELECT, TEXT, DATE-TIME'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: 'must be equal to one of the allowed values: SELECT, TEXT, DATE-TIME'
            reason: INVALID_ENUM_VALUE
            locationType: body
            location: /approvalSettings/approvals/0/approverFields/0/type
            domain: governance
    requester-fields-type-invalid:
      summary: When requester field type is invalid
      description: When requester field type is invalid
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requestSettings/requesterFields/0/type must be equal to one of the allowed values: SELECT, TEXT, DATE-TIME'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: 'must be equal to one of the allowed values: SELECT, TEXT, DATE-TIME'
            reason: INVALID_ENUM_VALUE
            locationType: body
            location: /requestSettings/requesterFields/0/type
            domain: governance
    no-approvals:
      description: When approvals is empty array
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /approvalSettings/approvals must NOT have fewer than 1 items'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: must NOT have fewer than 1 items
            reason: INVALID_ARRAY_LENGTH_UNDER_MIN
            locationType: body
            location: /approvalSettings/approvals
            domain: governance
    ownerId-invalid:
      description: When ownerId is invalid
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: ownerId must be a Team in your organization.'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: ownerId must be a Team in your organization.
            reason: IDENTIFIER_NOT_FOUND
            locationType: body
            location: ownerId
            domain: governance
    ownerId-missing:
      summary: When ownerId is missing
      description: When /ownerId is missing
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: must have required property ''ownerId'''
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: must have required property 'ownerId'
            reason: REQUIRED_PROPERTY_MISSING
            locationType: body
            location: /ownerId
            domain: governance
    request-settings-missing:
      summary: When requestSettings is missing
      description: When /requestSettings is missing
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: must have required property ''requestSettings'''
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: must have required property 'requestSettings'
            reason: REQUIRED_PROPERTY_MISSING
            locationType: body
            location: /
            domain: governance
    ownerId-and-settings-missing:
      summary: When ownerId and resourceSettings are missing
      description: When /ownerId /resourceSettings are missing
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: must have required property ''ownerId'', must have required property ''resourceSettings'''
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: must have required property 'ownerId'
            reason: REQUIRED_PROPERTY_MISSING
            locationType: body
            location: /ownerId
            domain: governance
          - errorSummary: must have required property 'resourceSettings'
            reason: REQUIRED_PROPERTY_MISSING
            locationType: body
            location: /resourceSettings
            domain: governance
    approval-settings-missing:
      summary: When approvalSettings is missing
      description: When /approvalSettings is missing
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: must have required property ''approvalSettings'''
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: must have required property 'approvalSettings'
            reason: REQUIRED_PROPERTY_MISSING
            locationType: body
            location: /
            domain: governance
    request-type-get-published:
      summary: When getting a request type in published status
      description: When getting a request type in published status
      value:
        id: 61eb2db568c7c300079fefd0
        name: salesforce-01
        description: How users can request access to Salesforce 01
        created: '2019-08-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: ACTIVE
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: GROUPS
          targetResources:
            - resourceId: 00g1emaKYZTWRYYRRTSK
        requestSettings:
          type: EVERYONE
          requesterFields:
            - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
              prompt: What is the business justification?
              required: true
              type: TEXT
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MEMBER_OF
              description: Approval from a member of the specified OKTA group
              approverMemberOf:
                - 00g1emaKYZTWRYYRRTSK
              approverFields:
                - id: ec9da40d-9c1b-41c6-8016-edfd010b02d2
                  prompt: What is the business justification?
                  required: true
                  type: TEXT
        lastUpdateSource: API
        accessDuration: null
        _links:
          createRequest:
            href: https://my-org.at.okta.com/next/new?q=Request%20access%20to%20Salesforce&request_type=0oa1gjh63g214q0Hq0g4
            type: text/html
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2261eb2db568c7c300079fefd0%22
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
    request-type-get-un-published:
      summary: When getting a request type in draft status
      description: When getting a request type in draft status
      value:
        id: 61eb2db568c7c300079fefd0
        name: salesforce-01
        description: How users can request access to Salesforce 01
        created: '2019-08-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2019-08-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        status: DRAFT
        ownerId: 61eb0f06c462d20007f051ac
        resourceSettings:
          type: GROUPS
          targetResources:
            - resourceId: 00g1emaKYZTWRYYRRTSK
        requestSettings:
          type: EVERYONE
          requesterFields:
            - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
              prompt: What is the business justification?
              required: true
              type: TEXT
        approvalSettings:
          type: SERIAL
          approvals:
            - approverType: MEMBER_OF
              description: Approval from a member of the specified OKTA group
              approverMemberOf:
                - 00g1emaKYZTWRYYRRTSK
              approverFields:
                - id: ec9da40d-9c1b-41c6-8016-edfd010b02d2
                  prompt: What is the business justification?
                  required: true
                  type: TEXT
        lastUpdateSource: API
        accessDuration: null
        _links:
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2261eb2db568c7c300079fefd0%22
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
    request-type-get-incompatible-example:
      summary: When getting a custom request type
      description: When getting a custom request type
      value:
        id: 61eb2db568c7c300079fefd0
        name: salesforce-01
        description: Request type created through WEB
        created: '2019-08-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2019-08-24T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        resourceSettings:
          type: CUSTOM
        requestSettings:
          type: CUSTOM
        approvalSettings:
          type: CUSTOM
        ownerId: 61eb0f06c462d20007f051ac
        status: ACTIVE
        lastUpdateSource: WEB
        accessDuration: null
        _links:
          requests:
            href: https://myorg.okta.com/governance/api/v1/requests?filter=requestTypeId%20eq%20%2261eb2db568c7c300079fefd0%22
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
            type: application/json
    request-type-publish-disabled-example:
      summary: When attempting to publish a DISABLED request type
      description: When attempting to publish a DISABLED request type
      value:
        errorCode: E0000195
        errorSummary: 'Api validation failed due to conflict: Cannot publish or unpublish a DISABLED request type. Repair the request type using the administrative user interface.'
        errorLink: E0000195
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses: []
    request-type-un-publish-disabled-example:
      summary: When attempting to publish a DISABLED request type
      description: When attempting to publish a DISABLED request type
      value:
        errorCode: E0000195
        errorSummary: 'Api validation failed due to conflict: Cannot publish or unpublish a DISABLED request type. Repair the request type using the administrative user interface.'
        errorLink: E0000195
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses: []
    requests-list-no-filter:
      summary: List Request response with no filter
      description: A List Request response with no filter
      value:
        data:
          - id: 61eb06a3c462d20007f0235c
            subject: Tom requests access to Salesforce
            requestTypeId: 61eb2db568c7c300079fefd0
            requesterUserIds:
              - 00ub0oNGTSWTBKOLGLNR
            created: '2022-05-24T14:15:22Z'
            createdBy: 00ub0oNGTSWTBKOLGLNR
            lastUpdated: '2022-05-24T14:15:22Z'
            lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
            permalinkId: 1
            resolved: '2022-05-24T14:15:22Z'
            requestStatus: RESOLVED
            type: ACCESS_REQUEST
            _links:
              requestType:
                href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
                type: application/json
              self:
                href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
                type: application/json
          - id: 61eb06a3c462d20007f0235c
            subject: request-from-service-now-xsd23432
            requestTypeId: 61eb2db568c7c300079fefd0
            requesterUserIds:
              - 00ub0oNGTSWTBKOLGLNR
            lastUpdated: '2022-05-05T14:15:22Z'
            lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
            created: '2022-05-05T14:15:22Z'
            createdBy: 00ub0oNGTSWTBKOLGLNR
            permalinkId: 2
            resolved: null
            requestStatus: OPEN
            type: CUSTOM
            _links:
              requestType:
                href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
                type: application/json
              self:
                href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
                type: application/json
        _links:
          self:
            href: https://myorg.okta.com/governance/api/v1/requests?limit=1
          next:
            href: https://myorg.okta.com/governance/api/v1/requests?limit=1&after=SDERDSDx00ub0oNGTSWTBKOLGLNR
    requests-list-bad-request-invalid-after:
      summary: When after parameter is invalid format
      description: When after query parameter value is invalid format (?after=1)
      value:
        errorCode: E0000029
        errorSummary: Invalid paging request.
        errorLink: E0000029
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: must NOT have fewer than 24 characters
            reason: INVALID_STRING_LENGTH_UNDER_MIN
            locationType: query
            location: /after
          - domain: governance
            errorSummary: must match pattern "^[a-fA-F\\d]{24}$"
            reason: STRING_FORMAT_INVALID
            locationType: query
            location: /after
          - domain: governance
            errorSummary: must be a request id
            reason: STRING_FORMAT_INVALID
            locationType: query
            location: /after
    requests-list-bad-request-not-exist-after:
      summary: When after parameter value not found
      description: When a request contains after query parameter with request ID that does not exist
      value:
        errorCode: E0000029
        errorSummary: Invalid paging request.
        errorLink: E0000029
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: 08ab2db568c7c300079fefd0 not found
            reason: IDENTIFIER_NOT_FOUND
            locationType: query
            location: /after
            domain: governance
    request-00-create-no-requester-example:
      summary: When requesting for authenticated user
      description: Request access for authenticated user by omitting `requesterUserIds`
      value:
        requestTypeId: 08ab2db568c7c300079fefd0
        subject: I need access to Salesforce
    request-01-create-requester-example:
      summary: When requesting for non-authenticated user
      description: As an admin service account, request access for a user by providing `requesterUserIds`
      value:
        requestTypeId: 08ab2db568c7c300079fefd0
        subject: I need access to Salesforce
        requesterUserIds:
          - 00uijntSwJjSHtDY70g3
    request-02-create-field-values-example:
      summary: When request type has required fields
      description: As an admin service account, request access for a user and provide required field values
      value:
        requestTypeId: 08ab2db568c7c300079fefd0
        subject: I need access to Salesforce
        requesterFieldValues:
          - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
            value: To fulfill my job duties
          - id: ec9da40d-9c1b-41c6-8016-edfd010b02d2
            value: '2022-05-05T14:15:22Z'
          - id: 1c5ef673-8dbb-4b9c-ac76-0b4180116e43
            value:
              - Salesforce
    request-00-create-no-requester-example-full:
      summary: When requesting for authenticated user
      description: Request access for authenticated user by omitting `requesterUserIds`
      value:
        id: 61eb06a3c462d20007f0235c
        subject: Tom requests access to Salesforce
        requestTypeId: 08ab2db568c7c300079fefd0
        created: '2022-05-05T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-05T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        permalinkId: 1
        resolved: null
        requestStatus: OPEN
        requesterUserIds:
          - 00ub0oNGTSWTBKOLGLNR
        requesterFieldValues: null
        approvals:
          - status: PENDING
            approvalId: 62f6d63a1764a30007763ad5
          - status: PENDING
            approvalId: 62f6d63a1764a30007763ae2
        actions:
          - status: PENDING
            action: ASSIGN_APP_TO_USER
            actionId: 62f57938cd367b0008eb47c7
        type: ACCESS_REQUEST
        _links:
          requestType:
            href: https://myorg.okta.com/governance/api/v1/request-types/08ab2db568c7c300079fefd0
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
            type: application/json
    request-01-create-requester-example-full:
      summary: When requesting for non-authenticated user
      description: As an admin service account, request access for a user by providing `requesterUserIds`
      value:
        id: 61eb06a3c462d20007f0235c
        subject: Tom requests access to Salesforce
        requestTypeId: 08ab2db568c7c300079fefd0
        created: '2022-05-05T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-05T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        permalinkId: 1
        resolved: null
        requestStatus: OPEN
        requesterUserIds:
          - 00uijntSwJjSHtDY70g3
        requesterFieldValues: null
        approvals:
          - status: PENDING
            approvalId: 62f6d63a1764a30007763ad5
          - status: PENDING
            approvalId: 62f6d63a1764a30007763ae2
        actions:
          - status: PENDING
            action: ASSIGN_APP_TO_USER
            actionId: 62f57938cd367b0008eb47c7
        type: ACCESS_REQUEST
        _links:
          requestType:
            href: https://myorg.okta.com/governance/api/v1/request-types/08ab2db568c7c300079fefd0
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
            type: application/json
    request-pending-requester-field-values-example:
      summary: When request's request type has required requester fields
      description: When request's request type has required requester fields
      value:
        id: 61eb06a3c462d20007f0235c
        subject: Tom requests access to Salesforce
        requestTypeId: 61eb2db568c7c300079fefd0
        created: '2022-05-05T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-05T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        permalinkId: 1
        resolved: null
        requestStatus: OPEN
        requesterUserIds:
          - 00ub0oNGTSWTBKOLGLNR
        requesterFieldValues:
          - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
            prompt: What is the business justification for the request?
            type: TEXT
            required: true
            value: null
        approvals:
          - status: PENDING
            approvalId: 62f6d63a1764a30007763ad5
        actions:
          - status: PENDING
            action: ASSIGN_APP_TO_USER
            actionId: 62f57938cd367b0008eb47c7
        type: ACCESS_REQUEST
        _links:
          requestType:
            href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
            type: application/json
    request-02-create-field-values-example-full:
      summary: When request type has required fields
      description: As an admin service account, request access for a user by providing `requesterUserIds`
      value:
        id: 61eb06a3c462d20007f0235c
        subject: Tom requests access to Salesforce
        requestTypeId: 08ab2db568c7c300079fefd0
        created: '2022-05-05T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-05T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        permalinkId: 1
        resolved: null
        requestStatus: OPEN
        requesterUserIds:
          - 00uijntSwJjSHtDY70g3
        requesterFieldValues:
          - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
            required: true
            type: TEXT
            prompt: What is the business jutification?
            value: To fulfill my job duties
          - id: ec9da40d-9c1b-41c6-8016-edfd010b02d2
            required: true
            type: DATE-TIME
            prompt: When do you need access until?
            value: '2022-05-05T14:15:22Z'
          - id: 1c5ef673-8dbb-4b9c-ac76-0b4180116e43
            required: true
            type: SELECT
            prompt: What do you need access to?
            value:
              - Salesforce
        approvals:
          - status: PENDING
            approvalId: 62f6d63a1764a30007763ad5
          - status: PENDING
            approvalId: 62f6d63a1764a30007763ae2
        actions:
          - status: PENDING
            action: ASSIGN_APP_TO_USER
            actionId: 62f57938cd367b0008eb47c7
        type: ACCESS_REQUEST
        _links:
          requestType:
            href: https://myorg.okta.com/governance/api/v1/request-types/08ab2db568c7c300079fefd0
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
            type: application/json
    request-pending-only-approval-example:
      summary: When request's request type has no requester fields, one approval required
      description: When request's request type has no requester fields, one approval required
      value:
        id: 61eb06a3c462d20007f0235c
        subject: Tom requests access to Salesforce
        requestTypeId: 61eb2db568c7c300079fefd0
        created: '2022-05-05T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-05T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        permalinkId: 1
        resolved: null
        requestStatus: OPEN
        requesterUserIds:
          - 00ub0oNGTSWTBKOLGLNR
        requesterFieldValues: null
        approvals:
          - status: PENDING
            approvalId: 62f6d63a1764a30007763ad5
        actions:
          - status: PENDING
            action: ASSIGN_APP_TO_USER
            actionId: 62f57938cd367b0008eb47c7
        type: ACCESS_REQUEST
        _links:
          requestType:
            href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
            type: application/json
    request-pending-all-approvals-example:
      summary: When request's request type has no requester fields, many approvals required
      description: When request's request type has no requester fields, many approvals required
      value:
        id: 61eb06a3c462d20007f0235c
        subject: Tom requests access to Salesforce
        requestTypeId: 61eb2db568c7c300079fefd0
        created: '2022-05-05T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-05T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        permalinkId: 1
        resolved: null
        requestStatus: OPEN
        requesterUserIds:
          - 00ub0oNGTSWTBKOLGLNR
        requesterFieldValues: null
        approvals:
          - status: PENDING
            approvalId: 62f6d63a1764a30007763ad5
          - status: PENDING
            approvalId: 62f6d63a1764a30007763ae2
        actions:
          - status: PENDING
            action: ASSIGN_APP_TO_USER
            actionId: 62f57938cd367b0008eb47c7
        type: ACCESS_REQUEST
        _links:
          requestType:
            href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
            type: application/json
    requester-user-id-invalid-example:
      summary: When a requester user id cannot be found
      description: Bad request response when a requesterUserId cannot be found.
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requesterUserIds/0 00u22uiKQa0xXkbdGLNR not found'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: 00u22uiKQa0xXkbdGLNR not found
            location: /requesterUserIds/0
            locationType: body
            reason: IDENTIFIER_NOT_FOUND
    request-type-not-found-example:
      summary: When the request type cannot be found
      description: Bad request response when requestTypeId cannot be found.
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requestTypeId 61eb2db568c7c300079fefd0 not found'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: 61eb2db568c7c300079fefd0 not found
            location: /requestTypeId
            locationType: body
            reason: IDENTIFIER_NOT_FOUND
    request-field-id-missing-example:
      summary: When field id is not provided in fieldValues
      description: When the requesterFieldValues contains an item but no id is provided
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requesterFieldValues/0 must have required property ''id'''
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: must have required property 'id'
            location: /requesterFieldValues/0/id
            locationType: body
            reason: REQUIRED_PROPERTY_MISSING
    request-field-id-invalid-example:
      summary: When field id in requesterFieldValues is invalid
      description: When the requesterFieldValues contains an item and the id is invalid
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requesterFieldValues/0/id must be uuid v4'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: must be uuid v4
            location: /requesterFieldValues/0/id
            locationType: body
            reason: STRING_FORMAT_INVALID
    request-field-id-not-found-example:
      summary: When field ID not found
      description: When the `requesterFieldValues` contains an item with an `id` that can't be found
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requesterFieldValues/0/id 05c87fe9-11f6-4d40-a033-b155b39dcdbe not found'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: 05c87fe9-11f6-4d40-a033-b155b39dcdbe not found
            location: /requesterFieldValues/0/id
            locationType: body
            reason: IDENTIFIER_NOT_FOUND
    request-field-value-missing-example:
      summary: When field value is not provided in fieldValues
      description: When the requesterFieldValues contains an item but no value is provided
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requesterFieldValues/0 must have required property ''value'''
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: must have required property 'value'
            location: /requesterFieldValues/0/value
            locationType: body
            reason: REQUIRED_PROPERTY_MISSING
    request-field-value-invalid-example:
      summary: When field value in requesterFieldValues is invalid
      description: When the requesterFieldValues contains an item and the value is invalid
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requesterFieldValues/0/value must be date-time'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: must be date-time
            location: /requesterFieldValues/0/value
            locationType: body
            reason: STRING_FORMAT_INVALID
    request-field-type-missing-example:
      summary: When field type is not provided in fieldValues
      description: When the requesterFieldValues contains an item but no type is provided
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requesterFieldValues/0 must have required property ''type'''
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: must have required property 'type'
            location: /requesterFieldValues/0/value
            locationType: body
            reason: REQUIRED_PROPERTY_MISSING
    request-field-type-invalid-example:
      summary: When field type in requesterFieldValues is invalid
      description: When the requesterFieldValues contains an item and the type is invalid
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requesterFieldValues/0/type must be equal to one of the allowed values: TEXT, SELECT, DATE-TIME'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: 'must be equal to one of the allowed values: TEXT, SELECT, DATE-TIME'
            location: /requesterFieldValues/0/type
            locationType: body
            reason: INVALID_ENUM_VALUE
    request-create-authenticated-user-not-admin-example:
      summary: Authenticated user is not an admin
      description: Operation restricted to authenticated users with Super Admin or Access Request Admin role.
      value:
        errorCode: E0000006
        errorSummary: You do not have permission to perform the requested action.
        errorLink: E0000006
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            reason: INSUFFICIENT_PERMISSIONS
            errorSummary: Authenticated user must be a Super Admin or Access Request Admin.
    request-create-authenticated-user-not-member-of-example:
      summary: Authenticated user not member of group in request settings
      description: When the request's request type specifies that the requester must be a member of a group in /requestSettings/requesterMemberOf, that restriction also applies to the authenticated user.
      value:
        errorCode: E0000006
        errorSummary: You do not have permission to perform the requested action.
        errorLink: E0000006
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: Authenticated user and contents of /body/requesterUserIds must be members of the group specified in the request type's /requestSettings/requesterMemberOf array.
            location: /requesterUserIds
            locationType: body
            reason: REQUEST_TYPE_SETTINGS
    request-request-type-disabled-example:
      summary: When the request type in disabled status
      description: Conflict response when creating a request using a request type in disabled status.
      value:
        errorCode: E0000195
        errorSummary: 'Api validation failed due to conflict: Request type 61eb2db568c7c300079fefd0 must be ACTIVE. Current status: DISABLED'
        errorLink: E0000195
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: 'Request type 61eb2db568c7c300079fefd0 must be ACTIVE. Current status: DISABLED'
            location: /requestTypeId
            locationType: body
            reason: REQUEST_TYPE_STATE
    request-request-type-draft-example:
      summary: When the request type in draft status
      description: Conflict response when creating a request using a request type in draft status.
      value:
        errorCode: E0000195
        errorSummary: 'Api validation failed due to conflict: Request type 61eb2db568c7c300079fefd0 must be ACTIVE. Current status: DRAFT'
        errorLink: E0000195
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: 'Request type 61eb2db568c7c300079fefd0 must be ACTIVE. Current status: DRAFT'
            location: /requestTypeId
            locationType: body
            reason: REQUEST_TYPE_STATE
    request-required-field-missing-example:
      summary: When request is missing required requester field
      description: When the request type has a required requesterField, but the add request operation does not provide a matching requesterFieldValue
      value:
        errorCode: E0000001
        errorSummary: 'Api validation failed: /requesterFieldValues must have all required requesterFields'
        errorLink: E0000001
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: must have all required requesterFields
            location: /requesterFieldValues
            locationType: body
            reason: REQUEST_TYPE_SETTINGS
    request-get-fulfilled:
      summary: Resolved request with one approval
      description: Success response to get a Request
      value:
        id: 61eb06a3c462d20007f0235c
        subject: request-from-service-now-xsd23432
        requestTypeId: 61eb2db568c7c300079fefd0
        created: '2022-05-05T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-05T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        permalinkId: 1
        resolved: '2022-05-05T14:15:22Z'
        requestStatus: RESOLVED
        requesterUserIds:
          - 00ub0oNGTSWTBKOLGLNR
        requesterFieldValues:
          - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
            prompt: What is the business justification for the request?
            type: TEXT
            value: I need access to complete a task.
            required: true
        approvals:
          - status: COMPLETED
            approvalId: 62f6d63a1764a30007763ae2
            approverId: 00ub0oNGTSWTBKOLGLNR
            approverName: Becky Raferty
            decision: APPROVED
            decided: '2022-06-02T21:36:25.344Z'
            fieldValues:
              - id: ec9da40d-9c1b-41c6-8016-edfd010b02d2
                type: SELECT
                prompt: What is the business justification for the request?
                required: true
                value:
                  - Curious
        actions:
          - status: COMPLETED
            action: ASSIGN_APP_TO_USER
            actionId: 62f6d63a1764a30007763ad5
            actionStatus: SUCCEEDED
            actionAttempted: '2022-06-02T21:36:25.344Z'
            resourceId: 0oafxqCAJWWGELFTYASJ
            resourceName: Salesforce 01
            resourceType: APP
        type: ACCESS_REQUEST
        _links:
          requestType:
            href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
            type: application/json
    request-get-pending-missing-one-approval:
      summary: Open request with requester and approver field values
      description: Two required approvals, but one still pending
      value:
        id: 61eb06a3c462d20007f0235c
        subject: request-from-service-now-xsd23432
        requestTypeId: 61eb2db568c7c300079fefd0
        created: '2019-08-24T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-05T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        permalinkId: 1
        resolved: 2022-05-05T14:15:22Z'
        requestStatus: OPEN
        requesterUserIds:
          - 00ub0oNGTSWTBKOLGLNR
        requesterFieldValues:
          - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
            prompt: What is the business justification for the request?
            type: TEXT
            value: I need access to complete a task.
            required: true
        approvals:
          - status: COMPLETED
            approvalId: 62f6d63a1764a30007763ae2
            approverId: 00ub0oNGTSWTBKOLGLNR
            approverName: Becky Raferty
            decision: APPROVED
            decided: '2022-06-02T21:36:25.344Z'
            fieldValues:
              - id: ec9da40d-9c1b-41c6-8016-edfd010b02d2
                type: SELECT
                prompt: What is the business justification for the request?
                required: true
                value:
                  - Curious
          - status: PENDING
            approvalId: 62f6d63a1764a30007763ad5
        actions:
          - status: PENDING
            action: ASSIGN_APP_TO_USER
            actionId: 62f57938cd367b0008eb47c7
        type: ACCESS_REQUEST
        _links:
          requestType:
            href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
            type: application/json
    request-get-api-incompatible:
      summary: Request using CUSTOM Request Type
      description: Success response for GET Request using CUSTOM Request Type
      value:
        id: 61eb06a3c462d20007f0235c
        subject: request-from-service-now-xsd23432
        requestTypeId: 61eb2db568c7c300079fefd0
        lastUpdated: '2022-05-05T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        created: '2022-05-05T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        permalinkId: 1
        resolved: '2022-05-05T14:15:22Z'
        requestStatus: RESOLVED
        requesterUserIds:
          - 00ub0oNGTSWTBKOLGLNR
        requesterFieldValues:
          - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
            prompt: What is the business justification for the request?
            type: TEXT
            value: I need access to complete a task.
            required: true
        type: CUSTOM
        _links:
          requestType:
            href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
            type: application/json
    request-get-access-duration-expired:
      summary: Time bound access, ten day access duration
      description: A request where access has been granted, and the accessDuration has expired.
      value:
        id: 61eb06a3c462d20007f0235c
        subject: request-from-service-now-xsd23432
        requestTypeId: 61eb2db568c7c300079fefd0
        created: '2022-05-05T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-05T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        permalinkId: 1
        resolved: '2022-05-05T14:15:22Z'
        requestStatus: RESOLVED
        requesterUserIds:
          - 00ub0oNGTSWTBKOLGLNR
        requesterFieldValues:
          - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
            prompt: What is the business justification for the request?
            type: TEXT
            value: I need access to complete a task.
            required: true
        approvals:
          - status: COMPLETED
            approvalId: 62f6d63a1764a30007763ae2
            approverId: 00ub0oNGTSWTBKOLGLNR
            approverName: Becky Raferty
            decision: APPROVED
            decided: '2022-06-02T21:36:25.344Z'
            fieldValues:
              - id: ec9da40d-9c1b-41c6-8016-edfd010b02d2
                type: SELECT
                prompt: What is the business justification for the request?
                required: true
                value:
                  - Curious
        actions:
          - status: COMPLETED
            actionId: 62f6d63a1764a30007763ad5
            action: ASSIGN_APP_TO_USER
            actionStatus: SUCCEEDED
            actionAttempted: '2022-06-02T21:36:25.344Z'
            accessRemoved: '2022-06-12T21:36:25.344Z'
            resourceId: 0oafxqCAJWWGELFTYASJ
            resourceName: Salesforce 01
            resourceType: APP
        type: ACCESS_REQUEST
        _links:
          requestType:
            href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
            type: application/json
    request-get-access-duration-not-expired:
      summary: Time bound access, not yet expired
      description: A request where access has been granted, but it is time bounded and will be revoked in the future.
      value:
        id: 61eb06a3c462d20007f0235c
        subject: request-from-service-now-xsd23432
        requestTypeId: 61eb2db568c7c300079fefd0
        created: '2022-05-05T14:15:22Z'
        createdBy: 00ub0oNGTSWTBKOLGLNR
        lastUpdated: '2022-05-05T14:15:22Z'
        lastUpdatedBy: 00ub0oNGTSWTBKOLGLNR
        permalinkId: 1
        resolved: '2022-05-05T14:15:22Z'
        requestStatus: RESOLVED
        requesterUserIds:
          - 00ub0oNGTSWTBKOLGLNR
        requesterFieldValues:
          - id: 05c87fe9-11f6-4d40-a033-b155b39dcdbe
            prompt: What is the business justification for the request?
            type: TEXT
            value: I need access to complete a task.
            required: true
        approvals:
          - status: COMPLETED
            approvalId: 62f6d63a1764a30007763ae2
            approverId: 00ub0oNGTSWTBKOLGLNR
            approverName: Becky Raferty
            decision: APPROVED
            decided: '2022-06-02T21:36:25.344Z'
            fieldValues:
              - id: ec9da40d-9c1b-41c6-8016-edfd010b02d2
                type: SELECT
                prompt: What is the business justification for the request?
                required: true
                value:
                  - Curious
        actions:
          - status: COMPLETED
            action: ASSIGN_APP_TO_USER
            actionId: 62f6d63a1764a30007763ad5
            actionStatus: SUCCEEDED
            actionAttempted: '2022-06-02T21:36:25.344Z'
            accessRemoved: null
            resourceId: 0oafxqCAJWWGELFTYASJ
            resourceName: Salesforce 01
            resourceType: APP
        type: ACCESS_REQUEST
        _links:
          requestType:
            href: https://myorg.okta.com/governance/api/v1/request-types/61eb2db568c7c300079fefd0
            type: application/json
          self:
            href: https://myorg.okta.com/governance/api/v1/requests/61eb06a3c462d20007f0235c
            type: application/json
    request-message-00-create-message-audience-all:
      summary: When creating a request message visible for everyone with access to the request
      description: Add request message for authenticated user visible to all
      value:
        message: Contact admin@atko.com for any additional assistance needed with this request.
    request-message-01-create-message-referencing-another-system:
      summary: When embedding a reference to another application
      description: Including a link to another system for an approver.
      value:
        message: Find information about our access request policies here https://<company-internal-wiki-1>
    request-message-02-create-message-max-message-limit:
      summary: When creating a request message approaching the maximum length limit
      description: A very long message programmatically added to the request.
      value:
        message: 'This access created as part of Sally''s onboarding packet. Please ensure you have review company guidelines on application access located at: - https://<company-internal-wiki-1> - https://<company-internal-wiki-2> - https://<company-internal-wiki-3> - https://<company-internal-wiki-5> - https://<company-internal-wiki-6> - https://<company-internal-wiki-7> - https://<company-internal-wiki-8> - https://<company-internal-wiki-9> - https://<company-internal-wiki-10> - https://<company-internal-wiki-11> - https://<company-internal-wiki-12> - https://<company-internal-wiki-13> - https://<company-internal-wiki-14> - https://<company-internal-wiki-15> - https://<company-internal-wiki-16> - https://<company-internal-wiki-17> - https://<company-internal-wiki-18> - https://<company-internal-wiki-19> - https://<company-internal-wiki-20> - https://<company-internal-wiki-21> - https://<company-internal-wiki-22> - https://<company-internal-wiki-23> - https://<company-internal-wiki-24> - https://<company-internal-wiki-25> - https://<company-internal-wiki-25> - https://<company-internal-wiki-27> - https://<company-internal-wiki-28> - https://<company-internal-wiki-29> - https://<company-internal-wiki-30> - https://<company-internal-wiki-31> - https://<company-internal-wiki-32> - https://<company-internal-wiki-34> - https://<company-internal-wiki-35> - https://<company-internal-wiki-36> - https://<company-internal-wiki-37> - https://<company-internal-wiki-38> - https://<company-internal-wiki-39> - https://<company-internal-wiki-40> - https://<company-internal-wiki-42> - https://<company-internal-wiki-43> - https://<company-internal-wiki-44> - https://<company-internal-wiki-45> - https://<company-internal-wiki-46> - https://<company-internal-wiki-47> - https://<company-internal-wiki-48> - https://<company-internal-wiki-49> - https://<company-internal-wiki-50> - https://<company-internal-wiki-51> - https://<company-internal-wiki-52> - https://<company-internal-wiki-53> - https://<company-internal-wiki-54> - https://<company-internal-wiki-55> - https://<company-internal-wiki-56> - https://<company-internal-wiki-57> - https://<company-internal-wiki-58> - https://<company-internal-wiki-59> - https://<company-internal-wiki-60> - https://<company-internal-wiki-61> - https://<company-internal-wiki-62> - https://<company-internal-wiki-63> - https://<company-internal-wiki-64> - https://<company-internal-wiki-65> - https://<company-internal-wiki-66> - https://<company-internal-wiki-67> - https://<company-internal-wiki-68> - https://<company-internal-wiki-69> - https://<company-internal-wiki-70> - https://<company-internal-wiki-71> - https://<company-internal-wiki-72> - https://<company-internal-wiki-73> - https://<company-internal-wiki-74> - https://<company-internal-wiki-75> - https://<company-internal-wiki-76> - https://<company-internal-wiki-77> - https://<company-internal-wiki-78> - https://<company-internal-wiki-79> - https://<company-internal-wiki-80> - https://<company-internal-wiki-81> - https://<company-internal-wiki-82> - https://<company-internal-wiki-83> - https://<company-internal-wiki-84> - https://<company-internal-wiki-85> - https://<company-internal-wiki-86> - https://<company-internal-wiki-87> - https://<company-internal-wiki-88> - https://<company-internal-wiki-89> - https://<company-internal-wiki-90> - https://<company-internal-wiki-91> - https://<company-internal-wiki-92> - https://<company-internal-wiki-93> - https://<company-internal-wiki-94> - https://<company-internal-wiki-95> - https://<company-internal-wiki-96> - https://<company-internal-wiki-97> - https://<company-internal-wiki-98> - https://<company-internal-wiki-99>'
    teams-list-no-filter:
      summary: List teams
      description: A list of teams
      value:
        data:
          - id: 08ab2db568c7c300079fefd0
            name: Salesforce admins
            created: '2022-05-24T14:15:22Z'
            lastUpdated: '2022-05-24T14:15:22Z'
          - id: 08ab2db568c7c300079fefd0
            name: Netsuite admins
            created: '2022-05-24T14:15:22Z'
            lastUpdated: '2022-05-24T14:15:22Z'
    teams-list-bad-request-invalid-after:
      summary: When after parameter is invalid format
      description: When after query parameter value is invalid format (?after=1)
      value:
        errorCode: E0000029
        errorSummary: Invalid paging request.
        errorLink: E0000029
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - domain: governance
            errorSummary: must NOT have fewer than 24 characters
            reason: INVALID_STRING_LENGTH_UNDER_MIN
            locationType: query
            location: /after
          - domain: governance
            errorSummary: must match pattern "^[a-fA-F\\d]{24}$"
            reason: STRING_FORMAT_INVALID
            locationType: query
            location: /after
          - domain: governance
            errorSummary: must be a team id
            reason: STRING_FORMAT_INVALID
            locationType: query
            location: /after
    teams-list-bad-request-not-exist-after:
      summary: When after parameter value not found
      description: When a request contains after query parameter with team ID that does not exist
      value:
        errorCode: E0000029
        errorSummary: Invalid paging request.
        errorLink: E0000029
        errorId: oaeWCGz73hpRCG75VHP6-RRXw
        errorCauses:
          - errorSummary: 08ab2db568c7c300079fefd0 not found
            reason: IDENTIFIER_NOT_FOUND
            locationType: query
            location: /after
            domain: governance
  responses:
    request-types-list-success:
      description: A successful request type list response
      headers:
        Link:
          $ref: '#/components/headers/link'
        X-Rate-Limit-Limit:
          $ref: '#/components/headers/rate-limit-limit'
        X-Rate-Limit-Remaining:
          $ref: '#/components/headers/rate-limit-remaining'
        X-Rate-Limit-Reset:
          $ref: '#/components/headers/rate-limit-reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/request-types-list'
          examples:
            SuccessWithNoFilter:
              $ref: '#/components/examples/request-types-list-no-filter'
    request-types-list-bad-request:
      description: An invalid request to list request types
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            EmptyAfter:
              $ref: '#/components/examples/empty-after'
            InvalidAfterFormat:
              $ref: '#/components/examples/request-types-list-bad-request-invalid-after'
            AfterDoesNotExist:
              $ref: '#/components/examples/request-types-list-bad-request-not-exist-after'
            InvalidSort:
              $ref: '#/components/examples/invalid-sort'
            InvalidLimit:
              $ref: '#/components/examples/invalid-limit'
    authentication-error-response:
      description: Authentication fails error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            InvalidApiToken:
              summary: When the API token is invalid, the response body contains an error.
              value:
                errorCode: E0000004
                errorSummary: Authentication failed.
                errorLink: E0000004
                errorId: oaeWCGz73hpRCG75VHP6-RRXw
                errorCauses: []
    authorization-error-response:
      description: Authorization fails error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            errorCode: E0000004
            errorSummary: You don't have permission to perform the requested action.
            errorLink: E0000004
            errorId: oaeWCGz73hpRCG75VHP6-RRXw
            errorCauses: []
    resource-not-found-response:
      description: The requested resource wasn't found error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            errorCode: E0000007
            errorSummary: Resource not found exception
            errorLink: E0000007
            errorId: oaeWCGz73hpRCG75VHP6-RRXw
            errorCauses: []
    rate-limit-exceeded-response:
      description: The rate limit has been exceeded error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            errorCode: E0000047
            errorSummary: The API call exceeded the rate limit due to too many requests.
            errorLink: E0000047
            errorId: oaeWCGz73hpRCG75VHP6-RRXw
            errorCauses: []
    unexpected-error-response:
      description: Error response when a server fault occurs due to an unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            errorCode: E0000009
            errorSummary: Internal Server Error
            errorLink: E0000009
            errorId: oaeWCGz73hpRCG75VHP6-RRXw
            errorCauses: []
    request-types-create-success-response:
      description: A successful request type create response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/request-type-full'
          examples:
            Minimal:
              $ref: '#/components/examples/request-type-creatable-00-minimal-full-example'
            IncludingDefaults:
              $ref: '#/components/examples/request-type-creatable-01-request-anyone-no-questions-full-example'
            GroupManager:
              $ref: '#/components/examples/request-type-creatable-02-group-manager-full-example'
            AppManager:
              $ref: '#/components/examples/request-type-creatable-03-app-manager-full-example'
            AppManagerSelectField:
              $ref: '#/components/examples/request-type-creatable-04-app-manager-select-field-full-example'
            AppManagerTextField:
              $ref: '#/components/examples/request-type-creatable-05-app-manager-text-field-full-example'
            AppManagerDatetimeField:
              $ref: '#/components/examples/request-type-creatable-06-app-manager-datetime-field-full-example'
            MultistepApproval:
              $ref: '#/components/examples/request-type-creatable-07-approval-multi-step-full-example'
            OptionalQuestions:
              $ref: '#/components/examples/request-type-creatable-08-optional-questions-full-example'
            RequesterMemberOf:
              $ref: '#/components/examples/request-type-creatable-09-requester-memberof-full-example'
            PublishedWithAccessDuration:
              $ref: '#/components/examples/request-type-creatable-10-active-full-example'
            NoApprovals:
              $ref: '#/components/examples/request-type-creatable-11-no-approval-full-example'
            ApprovalDescription:
              $ref: '#/components/examples/request-type-creatable-12-approval-description-full-example'
            ResourceOwnerApproval:
              $ref: '#/components/examples/request-type-creatable-13-resource-owner-approval-full-example'
      headers:
        X-Rate-Limit-Limit:
          $ref: '#/components/headers/rate-limit-limit'
        X-Rate-Limit-Remaining:
          $ref: '#/components/headers/rate-limit-remaining'
        X-Rate-Limit-Reset:
          $ref: '#/components/headers/rate-limit-reset'
    request-types-create-bad-request-response:
      description: An invalid request to create a request type
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            InvalidGroupId:
              $ref: '#/components/examples/requester-memberOf-invalid-group-id'
            TooManyGroupIds:
              $ref: '#/components/examples/approval-memberOf-too-many-group-ids'
            MissingMemberOf:
              $ref: '#/components/examples/approval-missing-memberOf'
            LabelValueTooLong:
              $ref: '#/components/examples/fieldOptions-label-value-too-long'
            fieldOptionsMissing:
              $ref: '#/components/examples/fieldOptions-missing'
            ApprovalSettingsApproverFieldTypeInvalid:
              $ref: '#/components/examples/approver-fields-type-invalid'
            ApprovalSettingsRequesterFieldTypeInvalid:
              $ref: '#/components/examples/requester-fields-type-invalid'
            NoApprovals:
              $ref: '#/components/examples/no-approvals'
            TeamIdInvalid:
              $ref: '#/components/examples/ownerId-invalid'
            TeamIdMissing:
              $ref: '#/components/examples/ownerId-missing'
            SettingsMissing:
              $ref: '#/components/examples/request-settings-missing'
            TeamIdAndSettingsMissing:
              $ref: '#/components/examples/ownerId-and-settings-missing'
            MissingApprovalSettings:
              $ref: '#/components/examples/approval-settings-missing'
    request-type-get-success:
      description: A successful request type get response
      headers:
        Link:
          $ref: '#/components/headers/link'
        X-Rate-Limit-Limit:
          $ref: '#/components/headers/rate-limit-limit'
        X-Rate-Limit-Remaining:
          $ref: '#/components/headers/rate-limit-remaining'
        X-Rate-Limit-Reset:
          $ref: '#/components/headers/rate-limit-reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/request-type-full'
          examples:
            RequestTypeGetPublishedSuccess:
              $ref: '#/components/examples/request-type-get-published'
            RequestTypeGetUnPublishedSuccess:
              $ref: '#/components/examples/request-type-get-un-published'
            RequestTypeLastUpdateSourceUi:
              $ref: '#/components/examples/request-type-get-incompatible-example'
            Minimal:
              $ref: '#/components/examples/request-type-creatable-00-minimal-full-example'
            IncludingDefaults:
              $ref: '#/components/examples/request-type-creatable-01-request-anyone-no-questions-full-example'
            GroupManager:
              $ref: '#/components/examples/request-type-creatable-02-group-manager-full-example'
            AppManager:
              $ref: '#/components/examples/request-type-creatable-03-app-manager-full-example'
            AppManagerSelectField:
              $ref: '#/components/examples/request-type-creatable-04-app-manager-select-field-full-example'
            AppManagerTextField:
              $ref: '#/components/examples/request-type-creatable-05-app-manager-text-field-full-example'
            AppManagerDatetimeField:
              $ref: '#/components/examples/request-type-creatable-06-app-manager-datetime-field-full-example'
            MultistepApproval:
              $ref: '#/components/examples/request-type-creatable-07-approval-multi-step-full-example'
            OptionalQuestions:
              $ref: '#/components/examples/request-type-creatable-08-optional-questions-full-example'
            RequesterMemberOf:
              $ref: '#/components/examples/request-type-creatable-09-requester-memberof-full-example'
    request-type-delete-success-response:
      description: A successful request type delete response
      headers:
        Link:
          $ref: '#/components/headers/link'
        X-Rate-Limit-Limit:
          $ref: '#/components/headers/rate-limit-limit'
        X-Rate-Limit-Remaining:
          $ref: '#/components/headers/rate-limit-remaining'
        X-Rate-Limit-Reset:
          $ref: '#/components/headers/rate-limit-reset'
    request-type-publish-success-response:
      description: A successful request type publish response
      headers:
        Link:
          $ref: '#/components/headers/link'
        X-Rate-Limit-Limit:
          $ref: '#/components/headers/rate-limit-limit'
        X-Rate-Limit-Remaining:
          $ref: '#/components/headers/rate-limit-remaining'
        X-Rate-Limit-Reset:
          $ref: '#/components/headers/rate-limit-reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/request-type-full'
          examples:
            RequestTypeGetPublishedSuccess:
              $ref: '#/components/examples/request-type-get-published'
    request-type-publish-conflict-response:
      description: An invalid request to publish a request type
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            PublishDisabled:
              $ref: '#/components/examples/request-type-publish-disabled-example'
    request-type-un-publish-success-response:
      description: A successful request type unpublish response
      headers:
        Link:
          $ref: '#/components/headers/link'
        X-Rate-Limit-Limit:
          $ref: '#/components/headers/rate-limit-limit'
        X-Rate-Limit-Remaining:
          $ref: '#/components/headers/rate-limit-remaining'
        X-Rate-Limit-Reset:
          $ref: '#/components/headers/rate-limit-reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/request-type-full'
          examples:
            RequestTypeGetUnPublishedSuccess:
              $ref: '#/components/examples/request-type-get-un-published'
    request-type-un-publish-conflict-response:
      description: An invalid request due to status conflict when unpublishing a request type
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            UnpublishDeleted:
              $ref: '#/components/examples/request-type-un-publish-disabled-example'
    requests-list-success:
      description: A successful request list response
      headers:
        Link:
          $ref: '#/components/headers/link'
        X-Rate-Limit-Limit:
          $ref: '#/components/headers/rate-limit-limit'
        X-Rate-Limit-Remaining:
          $ref: '#/components/headers/rate-limit-remaining'
        X-Rate-Limit-Reset:
          $ref: '#/components/headers/rate-limit-reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/request-list'
          examples:
            SuccessWithNoFilter:
              $ref: '#/components/examples/requests-list-no-filter'
    requests-list-bad-request:
      description: An invalid request to list requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            EmptyAfter:
              $ref: '#/components/examples/empty-after'
            InvalidAfterFormat:
              $ref: '#/components/examples/requests-list-bad-request-invalid-after'
            AfterDoesNotExist:
              $ref: '#/components/examples/requests-list-bad-request-not-exist-after'
            InvalidSort:
              $ref: '#/components/examples/invalid-sort'
            InvalidLimit:
              $ref: '#/components/examples/invalid-limit'
    request-create-success-response:
      description: A successful create request response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/request-full'
          examples:
            NoRequester:
              $ref: '#/components/examples/request-00-create-no-requester-example-full'
            Requester:
              $ref: '#/components/examples/request-01-create-requester-example-full'
            RequestPendingRequesterFieldValues:
              $ref: '#/components/examples/request-pending-requester-field-values-example'
            RequestHasRequesterFieldValues:
              $ref: '#/components/examples/request-02-create-field-values-example-full'
            RequestPendingOnlyApproval:
              $ref: '#/components/examples/request-pending-only-approval-example'
            RequestPendingAllApprovals:
              $ref: '#/components/examples/request-pending-all-approvals-example'
      headers:
        X-Rate-Limit-Limit:
          $ref: '#/components/headers/rate-limit-limit'
        X-Rate-Limit-Remaining:
          $ref: '#/components/headers/rate-limit-remaining'
        X-Rate-Limit-Reset:
          $ref: '#/components/headers/rate-limit-reset'
    request-create-bad-request-response:
      description: An invalid request to create a request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            InvalidRequesterUserId:
              $ref: '#/components/examples/requester-user-id-invalid-example'
            RequesterTypeNotFound:
              $ref: '#/components/examples/request-type-not-found-example'
            FieldIdMissing:
              $ref: '#/components/examples/request-field-id-missing-example'
            FieldIdInvalid:
              $ref: '#/components/examples/request-field-id-invalid-example'
            FieldIdNotFound:
              $ref: '#/components/examples/request-field-id-not-found-example'
            FieldValueMissing:
              $ref: '#/components/examples/request-field-value-missing-example'
            FieldValueInvalid:
              $ref: '#/components/examples/request-field-value-invalid-example'
            FieldTypeMissing:
              $ref: '#/components/examples/request-field-type-missing-example'
            FieldTypeInvalid:
              $ref: '#/components/examples/request-field-type-invalid-example'
    request-create-forbidden-response:
      description: When authorization fails
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            NotAnAccessRequestAdmin:
              $ref: '#/components/examples/request-create-authenticated-user-not-admin-example'
            AuthenticatedUserNotMemberOf:
              $ref: '#/components/examples/request-create-authenticated-user-not-member-of-example'
            RequesterUserNotMemberOf:
              $ref: '#/components/examples/request-create-authenticated-user-not-member-of-example'
    request-create-conflict-response:
      description: A conflict with the request type prevents the create request operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            RequestTypeDisabled:
              $ref: '#/components/examples/request-request-type-disabled-example'
            RequestTypeDraft:
              $ref: '#/components/examples/request-request-type-draft-example'
            RequiredFieldMissing:
              $ref: '#/components/examples/request-required-field-missing-example'
    request-get-success:
      description: A successful get request response
      headers:
        Link:
          $ref: '#/components/headers/link'
        X-Rate-Limit-Limit:
          $ref: '#/components/headers/rate-limit-limit'
        X-Rate-Limit-Remaining:
          $ref: '#/components/headers/rate-limit-remaining'
        X-Rate-Limit-Reset:
          $ref: '#/components/headers/rate-limit-reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/request-full'
          examples:
            RequestGetFulfilled:
              $ref: '#/components/examples/request-get-fulfilled'
            RequestGetPendingMissingOneApproval:
              $ref: '#/components/examples/request-get-pending-missing-one-approval'
            RequestGetTypeCustom:
              $ref: '#/components/examples/request-get-api-incompatible'
            RequestGetTimeBoundedNotExpired:
              $ref: '#/components/examples/request-get-access-duration-expired'
            RequestGetTimeBoundedExpired:
              $ref: '#/components/examples/request-get-access-duration-not-expired'
    teams-list-success:
      description: A successful teams list response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/teams-list'
          examples:
            ListTeams:
              $ref: '#/components/examples/teams-list-no-filter'
      headers:
        Link:
          $ref: '#/components/headers/link'
    teams-list-bad-request:
      description: An invalid request to list teams
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            EmptyAfter:
              $ref: '#/components/examples/empty-after'
            InvalidAfterFormat:
              $ref: '#/components/examples/teams-list-bad-request-invalid-after'
            AfterDoesNotExist:
              $ref: '#/components/examples/teams-list-bad-request-not-exist-after'
            InvalidSort:
              $ref: '#/components/examples/invalid-sort'
            InvalidLimit:
              $ref: '#/components/examples/invalid-limit'