Resolve a Git group, project, owner or repository path to its scope qualifier

GET

/api/integrations/{provider}/{connectorId}/scope-targets/lookup

curl --request GET \
  --url 'https://opfield.example.com/api/integrations/gitlab/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/scope-targets/lookup?kind=group&path=example' \
  --header 'Authorization: Bearer <token>'

• Your Opfield instance

Turns a path into the stable qualifier Git scopes store: GitLab kind=group&path=team/sub or kind=project&path=team/sub/app, GitHub kind=owner&path=octo-org or kind=repo&path=octo-org/app. Returns qualifier relative to the connector (group/123); the full scope is <scope>:<connectorId>/<qualifier>. Only IDs are stored, so a later rename or move never changes what a grant covers. Needs integrations:<provider>:view on the connector or on anything in it; a path the caller may not view, or outside the connector allowlist, answers 404 like one that does not exist. Saving a permission group or additional user permissions also accepts <connectorId>/<kind>/path/<path> and stores the resolved ID.

Authorizations

• bearerAuth

Parameters

Path Parameters

provider

required

string

Allowed values: gitlab github

connectorId

required

string format: uuid

Query Parameters

kind

required

string

Allowed values: group project owner repo

path

required

string

>= 1 characters <= 255 characters /^[A-Za-z0-9_.-]+(?:\/[A-Za-z0-9_.-]+)*$/

Responses

200

Successful response

Media typeapplication/json

object

qualifier

required

string

kind

required

string

Allowed values: group project owner repo

id

required

string

path

required

string

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example resource",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:30:00.000Z"
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}