Skip to content
RallyHere Docs

Update Policy By Id

PUT
/v1/product/{product_id}/policy/{policy_id}

Update a policy by ID, requires policies:config:edit permission

Authorizations

Parameters

Path Parameters

policy_id
required

Policy ID

string format: uuid

Policy ID

product_id
required

Product ID

string format: uuid

Product ID

Request Body required

object
name
required

Policy name

string
>= 1 characters
permissions
required

List of permissions applied to the policy

Array<string>
description
required

Policy description

string
client_auth_enable

Enable Client Credential Authentication. This is recommended for services, automated processes, or third-parties.

boolean
default: true
user_auth_enable

Enable User Authentication (e.g. Steam, Xbox, PSN, Epic, Anon, etc). This is recommended for Game Clients and first-party websites.

boolean
default: true
refresh_token_enable

Enable Refresh tokens for authentications using this policy. If true, the refresh_token_lifetime_days field is used to limit how long the tokens remain valid.

boolean
default: true
access_token_lifetime_seconds

Access token lifetime in seconds

integer
default: 600 >= 600
refresh_token_lifetime_days

Refresh token lifetime in days. If empty, refresh tokens will not expire.

integer
default: 7 >= 7

Responses

200

Successful Response

object
policy_id
required
string format: uuid
name
required
string
permissions
required
Array<string>
description
required
string
default_policy
required
boolean
client_auth_enable

Enable Client Credential Authentication. This is recommended for services, automated processes, or third-parties.

boolean
default: true
user_auth_enable

Enable User Authentication (e.g. Steam, Xbox, PSN, Epic, Anon, etc). This is recommended for Game Clients and first-party websites.

boolean
default: true
refresh_token_enable

Enable Refresh tokens for authentications using this policy. If true, the refresh_token_lifetime_days field is used to limit how long the tokens remain valid.

boolean
default: true
access_token_lifetime_seconds

Access token lifetime in seconds

integer
default: 600 >= 600
refresh_token_lifetime_days

Refresh token lifetime in days. If empty, refresh tokens will not expire.

integer
default: 7 >= 7

400

Bad Request

404

Not Found

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string