Class AdminClient

관리자 클라이언트

조직 및 사용자 관리 API 기능을 제공합니다. 클라이언트 생성, 관리 등의 관리자 기능을 포함합니다.

Example

const adminClient = new AdminClient({
  accessKeyId: 'your-access-key',
  secretAccessKey: 'your-secret-key'
});

const newClient = await adminClient.createClient({
  externalId: 'my-client-1',
  name: 'My Service Client'
});

Index

Constructors

constructor

new AdminClient(credentials: AwesomeMessageCredentials): AdminClient
관리자 클라이언트 생성자
Parameters
- credentials: AwesomeMessageCredentials
  API 인증 크레덴셜
Returns AdminClient
Example
```
const adminClient = new AdminClient({
  accessKeyId: 'your-access-key',
  secretAccessKey: 'your-secret-key'
});
```
Overrides BaseClient.constructor

Methods

createClient

createClient(request: CreateClientRequest): Promise<CreateClientResponse>
새로운 클라이언트를 생성합니다.

조직 내에서 새로운 클라이언트를 생성하여 API 접근 권한을 부여합니다.
Parameters
- request: CreateClientRequest
  클라이언트 생성 요청 데이터
Returns Promise<CreateClientResponse>
생성된 클라이언트 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const createClientResponse = await adminClient.createClient({
  externalId: "my-client-1",
  name: "My Service Client"
});
// createClientResponse: { externalId: "my-client-1", name: "My Service Client" }
```

listClients

listClients(): Promise<Client[]>
조직의 모든 클라이언트 목록을 조회합니다.

현재 조직에 속한 모든 클라이언트의 목록을 반환합니다.

Returns Promise<Client[]>
클라이언트 목록
Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const clients = await adminClient.listClients();
// clients: [
//   { name: "My Service Client", externalId: "my-client-1", createdAt: "2025-01-01T00:00:00Z" },
//   { name: "Another Client", externalId: "another-service", createdAt: "2025-01-02T00:00:00Z" }
// ]
```

deleteClient

deleteClient(request: DeleteClientRequest): Promise<DeleteClientResponse>
클라이언트를 삭제합니다.

지정된 연동 ID를 가진 클라이언트를 삭제합니다. 삭제된 클라이언트는 더 이상 API에 접근할 수 없습니다.
Parameters
- request: DeleteClientRequest
  클라이언트 삭제 요청 데이터
Returns Promise<DeleteClientResponse>
삭제된 클라이언트 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const deleteClientResponse = await adminClient.deleteClient({
  externalId: "my-client-1"
});
// deleteClientResponse: { externalId: "my-client-1" }
```

`Protected`createSendHeaders

createSendHeaders(options?: SendOptions): Record<string, string>
SendOptions에서 HTTP 헤더를 생성합니다
Parameters
- Optionaloptions: SendOptions
  발송 옵션
Returns Record<string, string>
생성된 헤더 객체

Inherited from BaseClient.createSendHeaders

`Protected`get

get<T>(path: string, headers?: Record<string, string>): Promise<T>
GET 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.get

`Protected`post

post<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
POST 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.post

`Protected`postFormData

postFormData<T>(
    path: string,
    formData: FormData,
    headers?: Record<string, string>,
): Promise<T>
FormData를 사용한 POST 요청 (multipart/form-data)
Type Parameters
- T
Parameters
- path: string
  API 경로
- formData: FormData
  undici의 FormData 객체
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.postFormData

`Protected`put

put<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
PUT 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.put

`Protected`delete

delete<T>(path: string, headers?: Record<string, string>): Promise<T>
DELETE 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.delete

`Protected`deleteWithBody

deleteWithBody<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
DELETE 요청 (body 포함)
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.deleteWithBody

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class AdminClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns AdminClient

Example

Methods

createClient

Parameters

Returns Promise<CreateClientResponse>

Throws

Throws

Throws

Example

listClients

Returns Promise<Client[]>

Throws

Throws

Example

deleteClient

Parameters

Returns Promise<DeleteClientResponse>

Throws

Throws

Throws

Example

ProtectedcreateSendHeaders

Parameters

Returns Record<string, string>

Protectedget

Type Parameters

Parameters

Returns Promise<T>

Protectedpost

Type Parameters

Parameters

Returns Promise<T>

ProtectedpostFormData

Type Parameters

Parameters

Returns Promise<T>

Protectedput

Type Parameters

Parameters

Returns Promise<T>

Protecteddelete

Type Parameters

Parameters

Returns Promise<T>

ProtecteddeleteWithBody

Type Parameters

Parameters

Returns Promise<T>

Properties

Protectedcredentials

Settings

On This Page

`Protected`createSendHeaders

`Protected`get

`Protected`post

`Protected`postFormData

`Protected`put

`Protected`delete

`Protected`deleteWithBody

`Protected`credentials