Ask a person to connect GitHub for this organization

POST

/v2/github/authorization-requests

curl --request POST \
  --url https://api.runta.me/v2/github/authorization-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example" }'

• Hosted public API

Authorizations

• BearerAuth

Request Body^required

Media typeapplication/json

object

reason

What access is needed for, shown to the approver verbatim.

string

<= 512 characters

Example^generated

{
  "reason": "example"
}

Responses

200

Response envelope.

Media typeapplication/json

object

data

required

object

request_id

required

string

requested_by

required

string

reason

What the agent said it needed access for.

string

created_at_unix_seconds

required

integer format: int64

lifecycle

required

One of: discriminator: status

object

object

status

required

string

Allowed values: pending

authorization_url

required

string format: uri

expires_at_unix_seconds

required

integer format: int64

object

object

status

required

string

Allowed values: approved

decision

required

object

decided_by

required

string

decided_at_unix_seconds

required

integer format: int64

expires_at_unix_seconds

required

integer format: int64

object

object

status

required

string

Allowed values: installed

decision

required

object

decided_by

required

string

decided_at_unix_seconds

required

integer format: int64

installation_id

required

integer format: int64

object

object

status

required

string

Allowed values: denied

decision

required

object

decided_by

required

string

decided_at_unix_seconds

required

integer format: int64

object

object

status

required

string

Allowed values: expired

expires_at_unix_seconds

required

integer format: int64

decision

object

decided_by

required

string

decided_at_unix_seconds

required

integer format: int64

Example

{
  "data": {
    "lifecycle": {
      "status": "pending"
    }
  }
}

401

Missing, malformed, or rejected bearer token

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented

message

required

string

request_id

required

UUID v7 correlation ID shared with the X-Request-Id response header.

string

Example

{
  "error": {
    "code": "already_exists"
  }
}

403

The bearer token is not allowed to perform this action

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented

message

required

string

request_id

required

UUID v7 correlation ID shared with the X-Request-Id response header.

string

Example

{
  "error": {
    "code": "already_exists"
  }
}

404

The requested resource was not found

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented

message

required

string

request_id

required

UUID v7 correlation ID shared with the X-Request-Id response header.

string

Example

{
  "error": {
    "code": "already_exists"
  }
}

409

The request conflicts with current resource state

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented

message

required

string

request_id

required

UUID v7 correlation ID shared with the X-Request-Id response header.

string

Example

{
  "error": {
    "code": "already_exists"
  }
}

422

Validation or application error

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented

message

required

string

request_id

required

UUID v7 correlation ID shared with the X-Request-Id response header.

string

Example

{
  "error": {
    "code": "already_exists"
  }
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented

message

required

string

request_id

required

UUID v7 correlation ID shared with the X-Request-Id response header.

string

Example

{
  "error": {
    "code": "already_exists"
  }
}

501

Operation is not implemented

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented

message

required

string

request_id

required

UUID v7 correlation ID shared with the X-Request-Id response header.

string

Example

{
  "error": {
    "code": "already_exists"
  }
}

503

Upstream service is unavailable

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented

message

required

string

request_id

required

UUID v7 correlation ID shared with the X-Request-Id response header.

string

Example

{
  "error": {
    "code": "already_exists"
  }
}

504

Upstream request timed out

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented

message

required

string

request_id

required

UUID v7 correlation ID shared with the X-Request-Id response header.

string

Example

{
  "error": {
    "code": "already_exists"
  }
}

default

Error response

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented

message

required

string

request_id

required

UUID v7 correlation ID shared with the X-Request-Id response header.

string

Example

{
  "error": {
    "code": "already_exists"
  }
}