Get Policy By Id
GET /v1/product/{product_id}/policy/{policy_id}
GET
/v1/product/{product_id}/policy/{policy_id}
Get a policy by ID, requires policies:config:view 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
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
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
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
access_token_lifetime_seconds
Access token lifetime in seconds
integer
refresh_token_lifetime_days
Refresh token lifetime in days. If empty, refresh tokens will not expire.
integer
400
Bad Request
404
Not Found
422
Validation Error
object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string