Roles

Get Roles

GEThttps://api.paynow.gg/v1/stores/{storeId}/roles

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Response

200OKRoleDto[]

Show fields

idFlakeIdRequired

created_atstringRequired

created_byActorDtoRequired

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

descriptionstringRequired

namestringRequired

store_idFlakeIdRequired

permissionsobjectOptional

updated_atstringOptional

updated_byActorDtoOptional

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/roles" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.roles.getRoles();

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/roles", headers=headers)

Response200

[
  {
    "id": "411486491630370816",
    "created_at": "2024-01-01T00:00:00Z",
    "created_by": {
      "id": "411486491630370816",
      "type": "anonymous"
    },
    "description": "string",
    "name": "string",
    "store_id": "411486491630370816",
    "permissions": {},
    "updated_at": "2024-01-01T00:00:00Z",
    "updated_by": {
      "id": "411486491630370816",
      "type": "anonymous"
    }
  }
]

Create Role

POSThttps://api.paynow.gg/v1/stores/{storeId}/roles

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Request body

descriptionstringRequired

namestringRequired

permissionsobjectOptional

Response

201CreatedRoleDto

Show fields

idFlakeIdRequired

created_atstringRequired

created_byActorDtoRequired

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

descriptionstringRequired

namestringRequired

store_idFlakeIdRequired

permissionsobjectOptional

updated_atstringOptional

updated_byActorDtoOptional

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

Failed requests return a PayNowError body. See the error response guide.

curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/roles" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string",
  "name": "string",
  "permissions": {}
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.roles.createRole({
  description: "string",
  name: "string",
  permissions: {},
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "description": "string",
    "name": "string",
    "permissions": {},
}
response = requests.post("https://api.paynow.gg/v1/stores/{storeId}/roles", headers=headers, json=payload)

Response201

{
  "id": "411486491630370816",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "description": "string",
  "name": "string",
  "store_id": "411486491630370816",
  "permissions": {},
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  }
}

Get Available Permissions

GEThttps://api.paynow.gg/v1/stores/{storeId}/roles/permissions

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

Response

200OKAvailablePermissionDto[]

Show fields

idstringRequired

descriptionstringRequired

namestringRequired

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/roles/permissions" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.roles.getAvailablePermissions();

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/roles/permissions", headers=headers)

Response200

[
  {
    "id": "string",
    "description": "string",
    "name": "string"
  }
]

Get Role

GEThttps://api.paynow.gg/v1/stores/{storeId}/roles/{roleId}

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

roleIdFlakeIdRequired

Response

200OKRoleDto

Show fields

idFlakeIdRequired

created_atstringRequired

created_byActorDtoRequired

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

descriptionstringRequired

namestringRequired

store_idFlakeIdRequired

permissionsobjectOptional

updated_atstringOptional

updated_byActorDtoOptional

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/roles/{roleId}" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.roles.getRole("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/roles/{roleId}", headers=headers)

Response200

{
  "id": "411486491630370816",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "description": "string",
  "name": "string",
  "store_id": "411486491630370816",
  "permissions": {},
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  }
}

Update Role

PATCHhttps://api.paynow.gg/v1/stores/{storeId}/roles/{roleId}

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

roleIdFlakeIdRequired

Request body

descriptionstringOptional

namestringOptional

permissionsobjectOptional

Response

200OKRoleDto

Show fields

idFlakeIdRequired

created_atstringRequired

created_byActorDtoRequired

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

descriptionstringRequired

namestringRequired

store_idFlakeIdRequired

permissionsobjectOptional

updated_atstringOptional

updated_byActorDtoOptional

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

Failed requests return a PayNowError body. See the error response guide.

curl -X PATCH "https://api.paynow.gg/v1/stores/{storeId}/roles/{roleId}" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string",
  "name": "string",
  "permissions": {}
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.roles.updateRole("411486491630370816", {
  description: "string",
  name: "string",
  permissions: {},
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "description": "string",
    "name": "string",
    "permissions": {},
}
response = requests.patch("https://api.paynow.gg/v1/stores/{storeId}/roles/{roleId}", headers=headers, json=payload)

Response200

{
  "id": "411486491630370816",
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  },
  "description": "string",
  "name": "string",
  "store_id": "411486491630370816",
  "permissions": {},
  "updated_at": "2024-01-01T00:00:00Z",
  "updated_by": {
    "id": "411486491630370816",
    "type": "anonymous"
  }
}

Delete Role

DELETEhttps://api.paynow.gg/v1/stores/{storeId}/roles/{roleId}

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

roleIdFlakeIdRequired

Response

204No Content

Failed requests return a PayNowError body. See the error response guide.

curl -X DELETE "https://api.paynow.gg/v1/stores/{storeId}/roles/{roleId}" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

await paynow.roles.deleteRole("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.delete("https://api.paynow.gg/v1/stores/{storeId}/roles/{roleId}", headers=headers)