> ## Documentation Index
> Fetch the complete documentation index at: https://gproxy.leenhawk.com/llms.txt
> Use this file to discover all available pages before exploring further.

# POST /admin/api/credential-login/device/start



## OpenAPI

````yaml /generated/openapi.json post /admin/api/credential-login/device/start
openapi: 3.1.0
info:
  description: >-
    Forwarding, management, portal and OAuth APIs generated from Rust types.
    Input and output schemas preserve their respective Serde contracts.
    Streaming events and WebSocket messages are documented alongside HTTP
    payloads.
  title: GPROXY HTTP API
  version: 4.2.1
servers: []
security:
  - bearer: []
  - anthropicKey: []
  - googleKey: []
  - queryKey: []
paths:
  /admin/api/credential-login/device/start:
    post:
      tags:
        - Management
      summary: POST /admin/api/credential-login/device/start
      parameters:
        - description: Administrative scope selected by the caller.
          in: header
          name: x-gproxy-admin-scope
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Input_DeviceStart'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output_DeviceStarted'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output_Envelope'
          description: Gateway error
      security:
        - consoleSession: []
        - bearer: []
        - anthropicKey: []
        - googleKey: []
components:
  schemas:
    Input_DeviceStart:
      properties:
        label:
          default: null
          type:
            - string
            - 'null'
        owner:
          $ref: '#/components/schemas/Input_CredentialOwner'
          default:
            organizationId: null
            teamId: null
            userId: null
        providerId:
          type: string
      required:
        - providerId
      type: object
    Output_DeviceStarted:
      properties:
        expiresAtMs:
          description: When the upstream stops accepting this user code, if it said.
          format: int64
          type:
            - integer
            - 'null'
        intervalSecs:
          description: >-
            How long to wait before the first poll, and between polls. The
            upstream

            may raise it; a `Pending` answer always carries the current value.
          format: uint64
          minimum: 0
          type: integer
        loginSessionId:
          type: string
        userCode:
          description: What the person types on the other device.
          type: string
        verificationUri:
          type: string
        verificationUriComplete:
          description: |-
            The same page with the code already filled in, where the upstream
            offers one.
          type:
            - string
            - 'null'
      required:
        - loginSessionId
        - userCode
        - verificationUri
        - verificationUriComplete
        - intervalSecs
        - expiresAtMs
      type: object
    Output_Envelope:
      properties:
        error:
          $ref: '#/components/schemas/Output_EnvelopeBody'
      required:
        - error
      type: object
    Input_CredentialOwner:
      description: >-
        Who the credential belongs to, in the application layer's own
        vocabulary.

        Opaque to this crate: it copies the three columns through untouched, and

        only the layer above knows what an organization or a team is.
      properties:
        organizationId:
          default: null
          type:
            - string
            - 'null'
        teamId:
          default: null
          type:
            - string
            - 'null'
        userId:
          default: null
          type:
            - string
            - 'null'
      type: object
    Output_EnvelopeBody:
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object
  securitySchemes:
    bearer:
      scheme: bearer
      type: http
    anthropicKey:
      in: header
      name: x-api-key
      type: apiKey
    googleKey:
      in: header
      name: x-goog-api-key
      type: apiKey
    queryKey:
      in: query
      name: key
      type: apiKey
    consoleSession:
      in: cookie
      name: gproxy_session
      type: apiKey

````

## Related topics

- [POST /admin/api/credential-login/device/poll](https://gproxy.leenhawk.com/api-reference/management/post-adminapicredential-logindevicepoll.md)
- [POST /admin/api/credential-login/authcode/start](https://gproxy.leenhawk.com/api-reference/management/post-adminapicredential-loginauthcodestart.md)
- [POST /admin/api/credential-login/authcode/complete](https://gproxy.leenhawk.com/api-reference/management/post-adminapicredential-loginauthcodecomplete.md)
- [POST /admin/api/credentials](https://gproxy.leenhawk.com/api-reference/management/post-adminapicredentials.md)
- [POST /admin/api/credentials/{id}/quota-probe](https://gproxy.leenhawk.com/api-reference/management/post-adminapicredentials-quota-probe.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.