사용자

사용자에 대한 REST API 작업

개요

이러한 API 작업을 사용하여 상호작용합니다 사용자들 Panther에서.

API를 호출하려면, 다음을 참조하세요 Panther REST API 사용 방법 지침—포함하여 이 문서 페이지에서 직접 호출하는 방법에 대한 지침.

필수 권한

• 에 대해 GET 작업의 경우, API 토큰에는 사용자 정보 읽기 권한이 있어야 합니다.

• 에 대해 POST 및 DELETE 작업의 경우, API 토큰에는 사용자 관리 권한이 있어야 합니다.

작업

Create a user

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Body

application/json

emailstringRequired

The email address of the user

familyNamestringRequired

The family/last name of the user

givenNamestringRequired

The given/first name of the user

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

post

/users

HTTPcURLJavaScriptPython

POST /users HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "email": "text",
  "familyName": "text",
  "givenName": "text",
  "role": {
    "id": "text",
    "name": "text"
  }
}

{
  "createdAt": "text",
  "email": "text",
  "enabled": true,
  "familyName": "text",
  "givenName": "text",
  "id": "text",
  "lastLoggedInAt": "text",
  "role": {
    "id": "text",
    "name": "text"
  },
  "status": "text"
}

Get a user

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the user

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

get

/users/{id}

HTTPcURLJavaScriptPython

GET /users/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "createdAt": "text",
  "email": "text",
  "enabled": true,
  "familyName": "text",
  "givenName": "text",
  "id": "text",
  "lastLoggedInAt": "text",
  "role": {
    "id": "text",
    "name": "text"
  },
  "status": "text"
}

Update a user

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the user

Body

application/json

emailstringRequired

The email address of the user

familyNamestringRequired

The family/last name of the user

givenNamestringRequired

The given/first name of the user

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

post

/users/{id}

HTTPcURLJavaScriptPython

POST /users/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "email": "text",
  "familyName": "text",
  "givenName": "text",
  "role": {
    "id": "text",
    "name": "text"
  }
}

{
  "createdAt": "text",
  "email": "text",
  "enabled": true,
  "familyName": "text",
  "givenName": "text",
  "id": "text",
  "lastLoggedInAt": "text",
  "role": {
    "id": "text",
    "name": "text"
  },
  "status": "text"
}

Delete a user

delete

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the user

Responses

200

OK response.

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

delete

/users/{id}

HTTPcURLJavaScriptPython

DELETE /users/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

No content

List users

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Query parameters

cursorstringOptional

Pagination token

limitinteger · int64 · min: 1 · max: 60Optional

Maximum number of results to return

Default: 60

containsstringOptional

Search name and email fields in a case-insensitive fashion

emailstringOptional

An exact match of a user's email to return. If provided all other parameters are ignored

idstring[]Optional

Set of IDS to return

idsstringOptional

A comma delimited list of IDs

include-deactivatedbooleanOptional

Include deactivated users

statusstringOptional

Show only users with this Cognito status

Responses

200

OK response.

application/json

get

/users

HTTPcURLJavaScriptPython

GET /users HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

200

OK response.

{
  "next": "text",
  "results": [
    {
      "createdAt": "text",
      "email": "text",
      "enabled": true,
      "familyName": "text",
      "givenName": "text",
      "id": "text",
      "lastLoggedInAt": "text",
      "role": {
        "id": "text",
        "name": "text"
      },
      "status": "text"
    }
  ]
}