Source Control REST API

When a GitHub repository is onboarded, pull request discovery includes open pull requests created within the previous 72 hours.

Open pull requests created more than 72 hours before onboarding are not discovered through the onboarding discovery window. They can become discoverable after the pull request head branch is updated.

You can complete the source control onboarding flow through the /api/v2 REST API without using Easy SCM Onboarding or the user interface:

Apply user mappings to an organization in Lifecycle using the POST method.

The user mappings will be inherited by all organizations and applications under the specified organizationId.

POST /api/v2/sourceControl/automaticRoleAssignment/userMappings/{organizationId}

Request body as JSON:

{
  "role": "developer",
  "mappings":  [
    {
      "from": "SCM_EMAIL",
      "to": "IQ_EMAIL"
    },
  ]
}

Here is a complete example:

curl -u admin:admin123 \
  -X POST \
  -H "Content-Type: application/json" \
  --data-raw '{
    "role": "developer",
    "mappings": [
      {
        "from": "SCM_EMAIL",
        "to": "IQ_EMAIL"
      },
      {
        "from": "SCM_FULLNAME",
        "to": "IQ_FULLNAME"
      },
      {
        "from": "SCM_USERNAME",
        "to": "IQ_USERNAME"
      },
      {
        "from": "GITLOG_FULLNAME",
        "to": "IQ_FULLNAME"
      },
      {
        "from": "GITLOG_EMAIL",
        "to": "IQ_EMAIL"
      }
    ]
  }' \
  http://localhost:8070/api/v2/sourceControl/automaticRoleAssignment/userMappings/39cdb8dc95444802944545e3a6d8de8d

Lifecycle will attempt to match GitHub contributor emails to local/LDAP/SAML (release 192) user emails.

The table below explains each parameter:

You can also use any combination of the allowed values for the from and to fields such as in the example below:

{
  "from": "SCM_USERNAME",
  "to": "IQ_EMAIL"
},
{
  "from": "GITLOG_FULLNAME",
  "to": "IQ_USERNAME"
}

Here are some additional suggested user mappings:

{
  "from": "GITLOG_EMAIL",
  "to": "IQ_EMAIL"
},
{
  "from": "GITLOG_FULLNAME",
  "to": "IQ_FULLNAME"
},
{
  "from": "SCM_USERNAME",
  "to": "IQ_USERNAME"
},
{
  "from": "SCM_EMAIL",
  "to": "IQ_EMAIL"
},
{
  "from": "SCM_FULLNAME",
  "to": "IQ_FULLNAME"
}

Use the GET method to retrieve the SCM user mappings by specifying the organization or application.

GET /api/v2/sourceControl/automaticRoleAssignment/userMappings/{ownerType}/{ownerId}

The table below defines each input parameter:

The response provides the user mapping information:

{
  "organizationId": "80599b788da849a796c96e245770179f",
  "inherited": true,
  "userMapping": {
    "role": "developer",
    "mappings": [
      {"from": "GITHUB_EMAIL", "to": "IQ_USERNAME" },
      {"from": "GITLOG_EMAIL", "to": "IQ_EMAIL" },
      {"from": "GITHUB_FULLNAME", "to": "IQ_FULLNAME" }
    ]
  }
}

Each response field is explained in the table below:

Use the DELETE method to delete existing SCM user mappings by specifying the OrganizationId for which the user mappings were created.

DELETE /api/v2/sourceControl/automaticRoleAssignment/userMappings/{organizationId}

The input parameter organizationId is required.