Get List of Sources

Updated on Jun 8, 2025

3 minute(s) read

Prev Next

Get

/api/1.0/paa-groups/{envId}/{paaGroup}/sources

This API is is designed to retrieve Sources from a specific PAA Group.

Notice

Accessing the APIs is through a dedicated domain/URL, according to your PlainID Tenant Location

United States (US) - https://API.us1.plainid.io

Canada (CA) - https://api.ca1.plainid.io

Europe (EU) - https://api.eu1.plainid.io

Using HTML Encoded Special Characters

Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.

Important note about headers

Refer to the headers below to modify your cURL sample. Check if the following headers are in the sample, if not, ensure you add it to your cURL sample before pasting into your API tool.

Headers

*Required

Header	Value	cURL Line
Accept	`application/json`	`-H "Accept:application/json"`

cURL Sample Guidelines

In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right. They will then appear in the cURL sample on the bottom of the page in the correct format.

Security

HTTP

Type bearer

For more details about Administration API Authentication, check out the Authentication APIs documentation. Provide your bearer token in the Authorization header when making requests to protected resources. Example: Authorization: Bearer 123

Path parameters

envId

string (uuid) Required

The Environment ID can be found under the Details Tab in the Environment Settings.

paaGroup

stringRequired

The PAA Group Name

Query parameters

limit

integer

Minimum1

Maximum1000

Default50

offset

integer

Minimum0

Default0

detailed

boolean

False returns the Source IDs only. False returns the Source IDs only, True returns the entire Source.

Defaultfalse

Responses

200

Sources Retrieved

Headers

x-request-id

string

Sources Retrieved Successfully

{
  "data": [
    {
      "sourceId": "PIPS44BQJIJ2X3WG",
      "paaGroupId": "paa1",
      "adapter": "ws",
      "name": "auditadmin",
      "status": "ACTIVE",
      "description": "",
      "properties": {},
      "translator": {
        "name": "plainid-rest-tqK",
        "type": "plainid-rest",
        "properties": {
          "authConf": "/app/conf/auth-config.xml",
          "securityDomain": "oauth2-plainid-m-api",
          "supportsfilter": true
        }
      },
      "models": [
        {
          "type": "PHYSICAL",
          "modelId": "PIPMM44BQJIKBVA4G",
          "paaGroupId": "paa1",
          "visible": true,
          "name": "AdminAuditData",
          "description": "",
          "sourceIds": [
            "PIPS44BQJIJ2X3WG"
          ],
          "properties": {},
          "metadata": [
            {
              "type": "DDL",
              "text": "CREATE FOREIGN TABLE AdminAuditData (\nid string,\naction string,\nusreId string,\nresourceType string,\nresourceId string,\nresourceName string,\noff_set integer default 0\n) OPTIONS (nameinsource '$.data[*]', \"plainid:unwrap\" 'false' , \"plainid:method\" 'GET', \"plainid:URI\" '593f15f6-665e-4645-8293-35e41013c610?offset=0&limit=50');"
            }
          ]
        }
      ],
      "paasProperties": [
        {
          "id": "PIMR44BQJIYJSGZK",
          "sourceId": "PIPS44BQJIJ2X3WG",
          "paaId": "PAA3QK1UON1BOXS",
          "properties": {
            "EndPoint": "https://api.us1.plainid.io/api/1.0/audit-admin/",
            "Password": null,
            "AuthPassword": "plainid",
            "SecurityType": "None"
          }
        }
      ]
    },
    {
      "sourceId": "PIPS42Q4XHMNFA4G",
      "paaGroupId": "paa1",
      "adapter": "ws",
      "name": "azure",
      "status": "ACTIVE",
      "description": "",
      "properties": {
        "AuthConf": "/app/conf/auth-config.xml"
      },
      "translator": {
        "name": "plainid-azure-iKH",
        "type": "plainid-azure",
        "properties": {
          "enableNestedMemberOf": true,
          "authConf": "/app/conf/auth-config.xml",
          "securityDomain": "ps-auth2-massive",
          "defaultPageSize": "999",
          "maxWorkers": "120",
          "useExpandMemberOf": false,
          "enableGroupFirstMemberOf": true,
          "includeGroupsList": "SecurityGroup141,SecurityGroup143",
          "graphApiFilterToAppend": "Startswith(displayName,'Sec')",
          "accessTokenPrefix": "Bearer"
        }
      },
      "models": [
        {
          "type": "PHYSICAL",
          "modelId": "PIPMM42Q4XHOVC16O",
          "paaGroupId": "paa1",
          "visible": true,
          "name": "azure",
          "description": "",
          "sourceIds": [
            "PIPS42Q4XHMNFA4G"
          ],
          "properties": {},
          "metadata": [
            {
              "type": "DDL",
              "text": "CREATE FOREIGN TABLE Users (id string NOT NULL, onPremisesExtensionAttributes string options (\"plainid:inner-attribute-jsonpath\" '$.extensionAttribute1', \"plainid:parser\" 'jsonpath'),  displayName string \nUNIQUE, userPrincipalName string NOT NULL, CONSTRAINT PK_USERS \nPRIMARY KEY(id)) OPTIONS (UPDATABLE TRUE,nameinsource 'Users', \n\"teiid_odata:EntityType\" 'users',\"teiid_odata:Type\" \n'ENTITY_COLLECTION');\nCREATE FOREIGN TABLE UserGroups (displayName \nstring UNIQUE, userID string OPTIONS (UPDATABLE FALSE, \n\"teiid_odata:PSEUDO\" 'true'),id string,FOREIGN KEY(userID) REFERENCES \nUsers (id),CONSTRAINT PK_USERRS_GROUPS PRIMARY KEY(userID, id)) \nOPTIONS (NAMEINSOURCE 'memberOf', UPDATABLE TRUE, \n\"teiid_odata:NameInSchema\" 'memberOf',  \"teiid_odata:Type\" \n'NAVIGATION_COLLECTION');"
            }
          ]
        }
      ],
      "paasProperties": [
        {
          "id": "PIMR42Q4XHSYO1KW",
          "sourceId": "PIPS42Q4XHMNFA4G",
          "paaId": "PAA3QK1UON1BOXS",
          "properties": {
            "EndPoint": "https://graph.microsoft.com/v1.0",
            "Password": null,
            "AuthPassword": "plainid",
            "SecurityType": "None"
          }
        }
      ]
    }
  ],
  "meta": {
    "total": 8,
    "limit": 2,
    "offset": 0
  }
}

Expand All

object

data

Array of object

object

sourceId

string

paaGroupId

string

adapter

string

name

string

status

string

description

string

properties

object

translator

object

name

string

type

string

properties

object

models

Array of object

object

type

string

modelId

string

paaGroupId

string

visible

boolean

name

string

description

string

sourceIds

Array of string

string

properties

object

metadata

Array of object

object

type

string

text

string

paasProperties

Array of object

object

string

sourceId

string

paaId

string

properties

object