Partner Credentials

Operations on a channel partner's child organization credentials

get

Path parameters

partner_org_idstring · uuidRequired

child_org_idstring · uuidRequired

Query parameters

pageinteger · min: 1OptionalDefault: 1

page_sizeinteger · min: 1 · max: 100OptionalDefault: 20

Responses

200

OK

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/v2/partners/{partner_org_id}/orgs/{child_org_id}/credentials

GET /v2/partners/{partner_org_id}/orgs/{child_org_id}/credentials HTTP/1.1
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "org_id": "text",
    "name": "text",
    "client_id": null,
    "created_at": "2026-01-01T00:00:00.000Z",
    "user_id": null,
    "last_used_at": null,
    "expires_at": null,
    "revoked": true,
    "azure_tenant_id": null,
    "azure_csp_plan_subscription_id": null,
    "pac": null,
    "type": "tds_api_key",
    "user": {
      "id": "text",
      "username": "text",
      "full_name": null
    }
  }
]

post

Path parameters

partner_org_idstring · uuidRequired

child_org_idstring · uuidRequired

Body

valuestringRequired

client_idstringRequired

namestringOptionalDefault: PAC Proxy Credential

typestring · enumOptionalDefault: tds_api_keyPossible values:

expires_atstring · nullableOptionalDefault: null

azure_tenant_idstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\Z

azure_csp_plan_subscription_idstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\Z

pacstring · min: 1 · max: 255 · nullableOptionalDefault: null

Responses

201

Created

application/json

idstring · uuidRead-onlyRequired

org_idstring · max: 50Read-onlyRequired

namestringRead-onlyRequired

client_idstring · nullableRead-onlyRequired

created_atstring · date-timeRead-onlyRequired

user_idstring · max: 50 · nullableRead-onlyRequired

last_used_atstring · nullableRead-onlyRequired

expires_atstring · nullableRead-onlyRequired

revokedbooleanRead-onlyRequired

azure_tenant_idstring · max: 50 · nullableRead-onlyRequired

azure_csp_plan_subscription_idstring · max: 50 · nullableRead-onlyRequired

pacstring · max: 255 · nullableRead-onlyRequired

typestring · enumRead-onlyRequiredPossible values:

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

post/v2/partners/{partner_org_id}/orgs/{child_org_id}/credentials

POST /v2/partners/{partner_org_id}/orgs/{child_org_id}/credentials HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "value": "text",
  "client_id": "text",
  "name": "PAC Proxy Credential",
  "type": "tds_api_key",
  "expires_at": null,
  "azure_tenant_id": "text",
  "azure_csp_plan_subscription_id": "text",
  "pac": null
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "org_id": "text",
  "name": "text",
  "client_id": null,
  "created_at": "2026-01-01T00:00:00.000Z",
  "user_id": null,
  "last_used_at": null,
  "expires_at": null,
  "revoked": true,
  "azure_tenant_id": null,
  "azure_csp_plan_subscription_id": null,
  "pac": null,
  "type": "tds_api_key",
  "user": {
    "id": "text",
    "username": "text",
    "full_name": null
  }
}

get

Path parameters

partner_org_idstring · uuidRequired

child_org_idstring · uuidRequired

credential_idstring · uuidRequired

Responses

200

OK

application/json

idstring · uuidRead-onlyRequired

org_idstring · max: 50Read-onlyRequired

namestringRead-onlyRequired

client_idstring · nullableRead-onlyRequired

created_atstring · date-timeRead-onlyRequired

user_idstring · max: 50 · nullableRead-onlyRequired

last_used_atstring · nullableRead-onlyRequired

expires_atstring · nullableRead-onlyRequired

revokedbooleanRead-onlyRequired

azure_tenant_idstring · max: 50 · nullableRead-onlyRequired

azure_csp_plan_subscription_idstring · max: 50 · nullableRead-onlyRequired

pacstring · max: 255 · nullableRead-onlyRequired

typestring · enumRead-onlyRequiredPossible values:

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/v2/partners/{partner_org_id}/orgs/{child_org_id}/credentials/{credential_id}

GET /v2/partners/{partner_org_id}/orgs/{child_org_id}/credentials/{credential_id} HTTP/1.1
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "org_id": "text",
  "name": "text",
  "client_id": null,
  "created_at": "2026-01-01T00:00:00.000Z",
  "user_id": null,
  "last_used_at": null,
  "expires_at": null,
  "revoked": true,
  "azure_tenant_id": null,
  "azure_csp_plan_subscription_id": null,
  "pac": null,
  "type": "tds_api_key",
  "user": {
    "id": "text",
    "username": "text",
    "full_name": null
  }
}

delete

Path parameters

partner_org_idstring · uuidRequired

child_org_idstring · uuidRequired

credential_idstring · uuidRequired

Responses

204

No Content

No content

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

500

Internal server error

application/json

default

Default error response

application/json

delete/v2/partners/{partner_org_id}/orgs/{child_org_id}/credentials/{credential_id}

DELETE /v2/partners/{partner_org_id}/orgs/{child_org_id}/credentials/{credential_id} HTTP/1.1
Accept: */*

No content

patch

Path parameters

partner_org_idstring · uuidRequired

child_org_idstring · uuidRequired

credential_idstring · uuidRequired

Body

namestringOptional

revokedbooleanOptional

Responses

200

OK

application/json

idstring · uuidRead-onlyRequired

org_idstring · max: 50Read-onlyRequired

namestringRead-onlyRequired

client_idstring · nullableRead-onlyRequired

created_atstring · date-timeRead-onlyRequired

user_idstring · max: 50 · nullableRead-onlyRequired

last_used_atstring · nullableRead-onlyRequired

expires_atstring · nullableRead-onlyRequired

revokedbooleanRead-onlyRequired

azure_tenant_idstring · max: 50 · nullableRead-onlyRequired

azure_csp_plan_subscription_idstring · max: 50 · nullableRead-onlyRequired

pacstring · max: 255 · nullableRead-onlyRequired

typestring · enumRead-onlyRequiredPossible values:

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

patch/v2/partners/{partner_org_id}/orgs/{child_org_id}/credentials/{credential_id}

PATCH /v2/partners/{partner_org_id}/orgs/{child_org_id}/credentials/{credential_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "revoked": true
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "org_id": "text",
  "name": "text",
  "client_id": null,
  "created_at": "2026-01-01T00:00:00.000Z",
  "user_id": null,
  "last_used_at": null,
  "expires_at": null,
  "revoked": true,
  "azure_tenant_id": null,
  "azure_csp_plan_subscription_id": null,
  "pac": null,
  "type": "tds_api_key",
  "user": {
    "id": "text",
    "username": "text",
    "full_name": null
  }
}