Skip to content
RallyHere Docs

Update Client By Id

PUT
/v1/product/{product_id}/client/{client_id}

Update a client by ID, requires clients:config:edit permission

Authorizations

Parameters

Path Parameters

client_id
required

Client ID

string format: uuid

Client ID

product_id
required

Product ID

string format: uuid

Product ID

Request Body required

object
name
required

Client name

string
>= 1 characters
policy_id
required

Policy ID to use for the client

string format: uuid
description
required

Client description

string
rotate_secret

Rotate the client secret

boolean

Responses

200

Successful Response

object
client_id
required
string format: uuid
client_secret

Client secret. Note the value of the secret is returned only when the secret is first generated or the secret is rotated.

string
name
required
string
policy
required
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
description
required
string

400

Bad Request

404

Not Found

422

Validation Error

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