Skip to content
Prefactor Docs

Update a pool

PUT
/api/v1/pool/{pool_id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
pool_id
required
Pool_Id

A valid pool ID

string
013xrzp12g3nqk8ng09nmc8kwqzfafa2

Request Body

Section titled “Request Body ”
Pool_DetailsForUpdate
object
authentication_ruleset_nid
One of:
Domain_Ruleset_Nid

A valid domain ruleset NID

string
013xrzp12g3nqk8nbff463k4y6t47ez2
metadata
One of:
object
key
additional properties
string
title
One of:
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
details
Pool_Details
object
account_id
Account_Id

A valid account ID

string
013xrzp12g3nqk8n6cyr5x0k8yb10h59
authentication_ruleset_nid
Domain_Ruleset_Nid

A valid domain ruleset NID

string
013xrzp12g3nqk8nbff463k4y6t47ez2
domain_id
Domain_Id

A valid domain ID

string
013xrzp12g3nqk8n32sd3jyxq5a8ywe2
id
Pool_Id

A valid pool ID

string
013xrzp12g3nqk8ng09nmc8kwqzfafa2
metadata
object
key
additional properties
string
oauth_discovery_uri
Uri

URI

string format: uri 
https://example.com
oauth_issuer_uri
Uri

URI

string format: uri 
https://example.com
status
string
Allowed values: extant deleted 
extant
title
string
type
string
Allowed values: pool 
pool
status
string
Allowed values: success 
success

default

Section titled “default ”

Error

One of:
object
code
string
Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_value required_value 
bad_request
message
string
status
string
Allowed values: error 
error