역할

역할에 대한 REST API 작업

개요

다음 API 작업을 사용하여 상호작용합니다 사용자 역할 Panther에서.

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

필요 권한

다음의 경우 GET 작업의 경우, API 토큰은 다음을 갖고 있어야 합니다 Read User Info 권한.
다음의 경우 POST 및 DELETE 작업의 경우, API 토큰은 다음을 갖고 있어야 합니다 Manage Users 권한.

작업

Create a role

post

Authorizations

X-API-KeystringRequired

Body

logTypeAccessstring[]Optional

The log types that the role can or cannot access, according to the logTypeAccessKind field. This field should be omitted if logTypeAccessKind has a value of ALLOW_ALL or DENY_ALL

logTypeAccessKindstring · enumOptional

Defines the role's access to log types. This field is required and has effect only if the datalake RBAC feature is enabled.

Possible values:

namestringRequired

The name of the role

Responses

200

OK response.

application/json

createdAtstringOptional

idstringOptional

ID of the role

logTypeAccessstring[]Optional

The log types that the role can or cannot access, according to the logTypeAccessKind field. This field should be omitted if logTypeAccessKind has a value of ALLOW_ALL or DENY_ALL

logTypeAccessKindstring · enumRequired

Defines the role's access to log types. This field is required and has effect only if the datalake RBAC feature is enabled.

Possible values:

namestringRequired

The name of the role

updatedAtstringOptional

400

bad_request: Bad Request response.

application/json

post

/roles

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

{
  "logTypeAccess": [
    "text"
  ],
  "logTypeAccessKind": "ALLOW",
  "name": "text",
  "permissions": [
    "AlertModify"
  ]
}

{
  "createdAt": "text",
  "id": "text",
  "logTypeAccess": [
    "text"
  ],
  "logTypeAccessKind": "ALLOW",
  "name": "text",
  "permissions": [
    "AlertModify"
  ],
  "updatedAt": "text"
}

Get a role

get

Authorizations

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the role

Responses

200

OK response.

application/json

createdAtstringOptional

idstringOptional

ID of the role

logTypeAccessstring[]Optional

The log types that the role can or cannot access, according to the logTypeAccessKind field. This field should be omitted if logTypeAccessKind has a value of ALLOW_ALL or DENY_ALL

logTypeAccessKindstring · enumRequired

Defines the role's access to log types. This field is required and has effect only if the datalake RBAC feature is enabled.

Possible values:

namestringRequired

The name of the role

updatedAtstringOptional

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

get

/roles/{id}

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

{
  "createdAt": "text",
  "id": "text",
  "logTypeAccess": [
    "text"
  ],
  "logTypeAccessKind": "ALLOW",
  "name": "text",
  "permissions": [
    "AlertModify"
  ],
  "updatedAt": "text"
}

Update a role

post

Authorizations

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the role

Body

logTypeAccessstring[]Optional

The log types that the role can or cannot access, according to the logTypeAccessKind field. This field should be omitted if logTypeAccessKind has a value of ALLOW_ALL or DENY_ALL

logTypeAccessKindstring · enumOptional

Defines the role's access to log types. This field is required and has effect only if the datalake RBAC feature is enabled.

Possible values:

namestringRequired

The name of the role

Responses

200

OK response.

application/json

createdAtstringOptional

idstringOptional

ID of the role

logTypeAccessstring[]Optional

The log types that the role can or cannot access, according to the logTypeAccessKind field. This field should be omitted if logTypeAccessKind has a value of ALLOW_ALL or DENY_ALL

logTypeAccessKindstring · enumRequired

Defines the role's access to log types. This field is required and has effect only if the datalake RBAC feature is enabled.

Possible values:

namestringRequired

The name of the role

updatedAtstringOptional

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

post

/roles/{id}

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

{
  "logTypeAccess": [
    "text"
  ],
  "logTypeAccessKind": "ALLOW",
  "name": "text",
  "permissions": [
    "AlertModify"
  ]
}

{
  "createdAt": "text",
  "id": "text",
  "logTypeAccess": [
    "text"
  ],
  "logTypeAccessKind": "ALLOW",
  "name": "text",
  "permissions": [
    "AlertModify"
  ],
  "updatedAt": "text"
}

Delete a role

delete

Authorizations

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the role

Responses

200

OK response.

No content

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

delete

/roles/{id}

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

No content

List roles

get

Authorizations

X-API-KeystringRequired

Query parameters

name-containsstringOptional

A string to search for in the Role name

namestringOptional

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

idstring[]Optional

Set of IDS to return

idsstringOptional

A comma delimited list of IDs

sort-dirstring · enumOptional

The sort direction of the results

Default: ascPossible values:

Responses

200

OK response.

application/json

nextstringOptional

Pagination token for the next page of results

get

/roles

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

200

OK response.

{
  "next": "text",
  "results": [
    {
      "createdAt": "text",
      "id": "text",
      "logTypeAccess": [
        "text"
      ],
      "logTypeAccessKind": "ALLOW",
      "name": "text",
      "permissions": [
        "AlertModify"
      ],
      "updatedAt": "text"
    }
  ]
}

이전쿼리 다음룰

마지막 업데이트 11일 전

도움이 되었나요?

hashtag개요

hashtag필요 권한

hashtag작업

hashtagCreate a role

hashtagGet a role

hashtagUpdate a role

hashtagDelete a role

hashtagList roles

개요

필요 권한

작업

Create a role

Get a role

Update a role

Delete a role

List roles