Authentication
Connections
Data Masking Rules
AWS
Guard Rails
Server Management
Jira
Organization Management
Plugins
Reports
User Management
Sessions
Session
Server Management
Update Authentication Configuration
Update authentication configuration
PUT
/
serverconfig
/
auth
Update Authentication Configuration
Copy
Ask AI
curl --request PUT \
--url https://use.hoop.dev/api/serverconfig/auth \
--header 'Content-Type: application/json' \
--data '{
"admin_role_name": "admin",
"auditor_role_name": "auditor",
"auth_method": "local",
"oidc_config": {
"audience": "hoop-audience",
"client_id": "hoop-client-id",
"client_secret": "hoop-client-secret",
"groups_claim": "groups",
"issuer_url": "https://auth.domain.tld/oidc",
"scopes": [
"openid",
"email",
"profile"
]
},
"rollout_api_key": "xapi-WqIAoYhKuIv2IPmVkfsyyK",
"saml_config": {
"groups_claim": "groups",
"idp_metadata_url": "https://auth.domain.tld/saml/metadata"
},
"webapp_users_management_status": "enabled"
}'
Copy
Ask AI
{
"admin_role_name": "admin",
"api_key": "xapi-WqIAoYhKuIv2IPmVkfsyyK",
"auditor_role_name": "auditor",
"auth_method": "local",
"oidc_config": {
"audience": "hoop-audience",
"client_id": "hoop-client-id",
"client_secret": "hoop-client-secret",
"groups_claim": "groups",
"issuer_url": "https://auth.domain.tld/oidc",
"scopes": [
"openid",
"email",
"profile"
]
},
"rollout_api_key": "xapi-WqIAoYhKuIv2IPmVkfsyyK",
"saml_config": {
"groups_claim": "groups",
"idp_metadata_url": "https://auth.domain.tld/saml/metadata"
},
"webapp_users_management_status": "enabled"
}
Body
application/json
The request body resource
The body is of type object
.
Response
200
application/json
OK
The response is of type object
.
Update Authentication Configuration
Copy
Ask AI
curl --request PUT \
--url https://use.hoop.dev/api/serverconfig/auth \
--header 'Content-Type: application/json' \
--data '{
"admin_role_name": "admin",
"auditor_role_name": "auditor",
"auth_method": "local",
"oidc_config": {
"audience": "hoop-audience",
"client_id": "hoop-client-id",
"client_secret": "hoop-client-secret",
"groups_claim": "groups",
"issuer_url": "https://auth.domain.tld/oidc",
"scopes": [
"openid",
"email",
"profile"
]
},
"rollout_api_key": "xapi-WqIAoYhKuIv2IPmVkfsyyK",
"saml_config": {
"groups_claim": "groups",
"idp_metadata_url": "https://auth.domain.tld/saml/metadata"
},
"webapp_users_management_status": "enabled"
}'
Copy
Ask AI
{
"admin_role_name": "admin",
"api_key": "xapi-WqIAoYhKuIv2IPmVkfsyyK",
"auditor_role_name": "auditor",
"auth_method": "local",
"oidc_config": {
"audience": "hoop-audience",
"client_id": "hoop-client-id",
"client_secret": "hoop-client-secret",
"groups_claim": "groups",
"issuer_url": "https://auth.domain.tld/oidc",
"scopes": [
"openid",
"email",
"profile"
]
},
"rollout_api_key": "xapi-WqIAoYhKuIv2IPmVkfsyyK",
"saml_config": {
"groups_claim": "groups",
"idp_metadata_url": "https://auth.domain.tld/saml/metadata"
},
"webapp_users_management_status": "enabled"
}
Assistant
Responses are generated using AI and may contain mistakes.