Class PrivateServiceEnrollmentResource

Index

Constructors

Methods

create get list

Constructors

constructor

new PrivateServiceEnrollmentResource(
http: HttpClient,
): PrivateServiceEnrollmentResource
Parameters
- http: HttpClient
Returns PrivateServiceEnrollmentResource
- Defined in packages/sdk/src/v1/resources/private_service_enrollments.ts:9

Methods

create

create(
input: { org?: string; private_service: string },
): Promise<CreatedPrivateServiceEnrollment>
Create a private service enrollment Creates or safely replaces an unreserved one-time connector enrollment token.
Parameters
- input: { org?: string; private_service: string }
  Request body.
  - Optionalorg?: string
    Organization ID or slug. Required for developer and server callers.
  - private_service: string
    Private service ID (pvs_...).
Returns Promise<CreatedPrivateServiceEnrollment>
Successful response
- Defined in packages/sdk/src/v1/resources/private_service_enrollments.ts:42

get

get(
privateServiceEnrollmentId: string,
params?: { org?: string },
): Promise<PrivateServiceEnrollment>
Retrieve a private service enrollment
Parameters
- privateServiceEnrollmentId: string
  Canonical certificate-bound service identity.
- Optionalparams: { org?: string }
  Query parameters.
  - Optionalorg?: string
    Organization ID or slug. Required for developer and server callers.
Returns Promise<PrivateServiceEnrollment>
Successful response
- Defined in packages/sdk/src/v1/resources/private_service_enrollments.ts:53

list

list(
params?: { org?: string; page?: number; pageSize?: number },
): Promise<PrivateServiceEnrollmentPage>
List private service enrollments
Parameters
- Optionalparams: { org?: string; page?: number; pageSize?: number }
  Query parameters.
  - Optionalorg?: string
    Organization ID or slug. Required for developer and server callers.
  - Optionalpage?: number
    Page number. Defaults to 1.
  - OptionalpageSize?: number
    Results per page. Defaults to 25; maximum is 100.
Returns Promise<PrivateServiceEnrollmentPage>
Successful response
- Defined in packages/sdk/src/v1/resources/private_service_enrollments.ts:19