Update Workspace
Update Workspace
Path Parameters
Header Parameters
Request Body
idstringRequired
Id of the workspace.
realmstringRequired
Name of the workspace.
realmLogostringRequired
Logo Url of the workspace.
workspacestringRequired
Workspace URL
notBeforenumberRequired
Not before timestamp value.
revokeRefreshTokenbooleanRequired
true/false for revoking the refresh token
refreshTokenMaxReusenumberRequired
Count of the refresh token max reuse.
accessTokenLifespannumberRequired
Lifespan of the access token.
accessTokenLifespanForImplicitFlownumberRequired
Lifespan of the access token in implicit flow.
ssoSessionIdleTimeoutnumberRequired
Timeout value of sso session idle state.
ssoSessionMaxLifespannumberRequired
Max lifespan of the sso session.
ssoSessionIdleTimeoutRememberMenumberRequired
Remember me idle session timeout value.
ssoSessionMaxLifespanRememberMenumberRequired
Max lifespan of Remember me for sso session.
offlineSessionIdleTimeoutnumberRequired
Timeout of idle offline session.
offlineSessionMaxLifespanEnabledbooleanRequired
true/false of Max lifespan for offline session is enabled or not.
offlineSessionMaxLifespannumberRequired
Max lifespan of the offline session.
clientSessionIdleTimeoutnumberRequired
Timeout of client idle session
clientSessionMaxLifespannumberRequired
Max lifespan of client session.
clientOfflineSessionIdleTimeoutnumberRequired
Timeout of the client idle offline session.
clientOfflineSessionMaxLifespannumberRequired
Max lifespan of client offline session
accessCodeLifespannumberRequired
Lifespan of the access code.
accessCodeLifespanUserActionnumberRequired
Lifespan of user action access code.
accessCodeLifespanLoginnumberRequired
Lifespan of the login access code.
actionTokenGeneratedByAdminLifespannumberRequired
Lifespan of action token generated by admin.
actionTokenGeneratedByUserLifespannumberRequired
Lifespan of the action token generated by user.
enabledbooleanRequired
true/false for workspace enabled or not.
sslRequiredstringRequired
true/false for ssl required or not.
verifyEmailbooleanRequired
true/false for email verified or not.
loginWithEmailAllowedbooleanRequired
true/false Login with email allowed or not.
duplicateEmailsAllowedbooleanRequired
true/false duplicate email allowed or not.
editUsernameAllowedbooleanRequired
true/false edit username allowed or not.
userInviteWaystringRequired
User invite way.
bruteForceProtectedbooleanRequired
true/false brute force protected or not.
permanentLockoutbooleanRequired
true/false permanent lockout or not.
maxFailureWaitSecondsnumberRequired
Max failure wait seconds.
minimumQuickLoginWaitSecondsnumberRequired
Minimum quick login wait seconds.
waitIncrementSecondsnumberRequired
Wait increment seconds.
quickLoginCheckMilliSecondsnumberRequired
Quick login check milliseconds.
maxDeltaTimeSecondsnumberRequired
Max delta time seconds.
failureFactornumberRequired
Failure factor
enabledOwnEmailProviderbooleanRequired
true/false for Own email provider enabled or not.
enabledOwnSmsProviderbooleanRequired
true/false for Own sms provider enabled or not.
defaultRolesarrayRequired
Array of default roles.
requiredCredentialsarrayRequired
Array of required credentials or not.
otpPolicyTypestringRequired
Type of the otp policy.
otpPolicyAlgorithmstringRequired
Otp policy algorithm
otpPolicyInitialCounternumberRequired
Otp policy algorithm
otpPolicyDigitsnumberRequired
Otp policy digits.
otpPolicyLookAheadWindownumberRequired
Otp policy look ahead window.
otpPolicyPeriodnumberRequired
Otp policy period
otpSupportedApplicationsarrayRequired
Otp supported Applications.
webAuthnPolicyRpEntityNamestringRequired
Entity name of the webauthn policrp
webAuthnPolicySignatureAlgorithmsarrayRequired
Array of webauthn policy signature algorithms.
webAuthnPolicyRpIdstringRequired
Webauthn policy rp ID
webAuthnPolicyAttestationConveyancePreferencestringRequired
Preference of the attestation conveyance preference.
webAuthnPolicyAuthenticatorAttachmentstringRequired
Webauthn policy authenticator attachment.
webAuthnPolicyRequireResidentKeystringRequired
Webauthn policy require residentkey.
webAuthnPolicyUserVerificationRequirementstringRequired
Webauthn policy user verification requirement.
webAuthnPolicyCreateTimeoutnumberRequired
Timeout to create webauthn policy
webAuthnPolicyAvoidSameAuthenticatorRegisterbooleanRequired
true/false webauthn policy avoid same authenticator register.
webAuthnPolicyAcceptableAaguidsarrayRequired
Array of webauthn policy acceptable aaguids.
webAuthnPolicyPasswordlessRpEntityNamestringRequired
EntityName of webauthn policy passwordlessRp
webAuthnPolicyPasswordlessSignatureAlgorithmsarrayRequired
Array of webauthn policy passwordless signature algorithms.
webAuthnPolicyPasswordlessRpIdstringRequired
Id of Webauthn policy passwordlessRp
webAuthnPolicyPasswordlessAttestationConveyancePreferencestringRequired
Webauthn policy passwordless attestation conveyance preference.
webAuthnPolicyPasswordlessAuthenticatorAttachmentstringRequired
Webauthn policy passwordless authenticator attachment.
webAuthnPolicyPasswordlessRequireResidentKeystringRequired
Webauthn policy passwordless require resident key.
webAuthnPolicyPasswordlessUserVerificationRequirementstringRequired
Webauthn policy passwordless verification requirement.
webAuthnPolicyPasswordlessCreateTimeoutnumberRequired
Create Timeout webauthn policy passwordless.
webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegisterbooleanRequired
Webauthn policy passwordless avoid same authenticator register.
webAuthnPolicyPasswordlessAcceptableAaguidsarrayRequired
Array of webauthn policy passwordless acceptable aaguids.
browserSecurityHeadersobjectRequired
Browser Security Headers.
smtpServerobjectRequired
SMTP server.
smsServerobjectRequired
SMS Server.
loginThemestringRequired
Login theme.
accountThemestringRequired
Account theme.
adminThemestringRequired
Admin theme.
emailThemestringRequired
Email theme.
eventsEnabledbooleanRequired
true/false Events enabled or not.
mfaProvidersarrayRequired
Array of MFA providers.
eventsListenersarrayRequired
Array of events listeners.
enabledEventTypesarrayRequired
true/false Enabled in event types.
adminEventsEnabledbooleanRequired
true/false Admin Events enabled.
adminEventsDetailsEnabledbooleanRequired
true/false Admin Events Details Enabled.
identityProvidersarrayRequired
Array of Identity Providers.
identityProviderMappersarray
Array of Identity provider mappers.
internationalizationEnabledbooleanRequired
true/false Internationalization Enabled.
supportedLocalesarrayRequired
Array of support Locales.
browserFlowstringRequired
Browser flow.
registrationFlowstringRequired
Registration Flow.
directGrantFlowstringRequired
Direct GrantFlow.
resetCredentialsFlowstringRequired
ResetCredentials flow.
clientAuthenticationFlowstringRequired
Client authentication flow.
dockerAuthenticationFlowstringRequired
Docker authentication flow.
attributesobject
Workspace attributes.
userManagedAccessAllowedbooleanRequired
true/false for user managed access allowed or not.
livebooleanRequired
true/false for live or not.
{
"id": "c99f3058-4e0e-4049-80cf-bbc0d8fb52d8",
"realm": "brand12",
"realmLogo": "",
"workspace": "https://brand12.dev.eztoauth.com",
"notBefore": 0,
"revokeRefreshToken": false,
"refreshTokenMaxReuse": 0,
"accessTokenLifespan": 300,
"accessTokenLifespanForImplicitFlow": 900,
"ssoSessionIdleTimeout": 1800,
"ssoSessionMaxLifespan": 36000,
"ssoSessionIdleTimeoutRememberMe": 0,
"ssoSessionMaxLifespanRememberMe": 0,
"offlineSessionIdleTimeout": 2592000,
"offlineSessionMaxLifespanEnabled": false,
"offlineSessionMaxLifespan": 5184000,
"clientSessionIdleTimeout": 0,
"clientSessionMaxLifespan": 0,
"clientOfflineSessionIdleTimeout": 0,
"clientOfflineSessionMaxLifespan": 0,
"accessCodeLifespan": 60,
"accessCodeLifespanUserAction": 300,
"accessCodeLifespanLogin": 1800,
"actionTokenGeneratedByAdminLifespan": 43200,
"actionTokenGeneratedByUserLifespan": 300,
"enabled": true,
"sslRequired": "external",
"verifyEmail": false,
"loginWithEmailAllowed": true,
"duplicateEmailsAllowed": false,
"editUsernameAllowed": false,
"userInviteWay": "otp",
"bruteForceProtected": false,
"permanentLockout": false,
"maxFailureWaitSeconds": 900,
"minimumQuickLoginWaitSeconds": 60,
"waitIncrementSeconds": 60,
"quickLoginCheckMilliSeconds": 1000,
"maxDeltaTimeSeconds": 43200,
"failureFactor": 30,
"enabledOwnEmailProvider": false,
"enabledOwnSmsProvider": false,
"defaultRoles": [
"user",
"offline_access",
"uma_authorization"
],
"requiredCredentials": [
"password"
],
"otpPolicyType": "totp",
"otpPolicyAlgorithm": "HmacSHA1",
"otpPolicyInitialCounter": 0,
"otpPolicyDigits": 6,
"otpPolicyLookAheadWindow": 1,
"otpPolicyPeriod": 30,
"otpSupportedApplications": [
"FreeOTP",
"Google Authenticator"
],
"webAuthnPolicyRpEntityName": "keycloak",
"webAuthnPolicySignatureAlgorithms": [
"ES256"
],
"webAuthnPolicyRpId": "",
"webAuthnPolicyAttestationConveyancePreference": "not specified",
"webAuthnPolicyAuthenticatorAttachment": "not specified",
"webAuthnPolicyRequireResidentKey": "not specified",
"webAuthnPolicyUserVerificationRequirement": "not specified",
"webAuthnPolicyCreateTimeout": 0,
"webAuthnPolicyAvoidSameAuthenticatorRegister": false,
"webAuthnPolicyAcceptableAaguids": [],
"webAuthnPolicyPasswordlessRpEntityName": "keycloak",
"webAuthnPolicyPasswordlessSignatureAlgorithms": [
"ES256"
],
"webAuthnPolicyPasswordlessRpId": "",
"webAuthnPolicyPasswordlessAttestationConveyancePreference": "not specified",
"webAuthnPolicyPasswordlessAuthenticatorAttachment": "not specified",
"webAuthnPolicyPasswordlessRequireResidentKey": "not specified",
"webAuthnPolicyPasswordlessUserVerificationRequirement": "not specified",
"webAuthnPolicyPasswordlessCreateTimeout": 0,
"webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister": false,
"webAuthnPolicyPasswordlessAcceptableAaguids": [],
"browserSecurityHeaders": {
"contentSecurityPolicyReportOnly": "",
"xContentTypeOptions": "nosniff",
"xRobotsTag": "none",
"xFrameOptions": "SAMEORIGIN",
"contentSecurityPolicy": "frame-src 'self' https://wchat.in.freshchat.com/ https://www.google.com/ ; frame-ancestors 'self'; object-src 'none';",
"xXSSProtection": "1; mode=block",
"strictTransportSecurity": "max-age=31536000; includeSubDomains"
},
"smtpServer": {},
"smsServer": {},
"loginTheme": "qlik_verify",
"accountTheme": "qlik_verify",
"adminTheme": "qlik_verify",
"emailTheme": "qlik_verify",
"eventsEnabled": false,
"mfaProviders": [],
"eventsListeners": [
"jboss-logging",
"email"
],
"enabledEventTypes": [],
"adminEventsEnabled": false,
"adminEventsDetailsEnabled": false,
"identityProviders": [],
"identityProviderMappers": [],
"internationalizationEnabled": false,
"supportedLocales": [],
"browserFlow": "browser",
"registrationFlow": "registration",
"directGrantFlow": "direct grant",
"resetCredentialsFlow": "reset credentials",
"clientAuthenticationFlow": "clients",
"dockerAuthenticationFlow": "docker auth",
"attributes": {},
"userManagedAccessAllowed": false,
"live": false
}
Response
requestIdstring
The unique identifier for the request.
userIdstring
The user's unique identifier.
{
"requestId": "b6e3f-8354-7bf718fb088",
(The response may differ based on the claims configured.)
"userId": "36deff26-5a9226e75a3",
}
| HTTP STATUS CODE SUMMARY | ||
|---|---|---|
| 200 - OK | Successfully done. | |
| 201 - OK | Successfully created. | |
| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. | |
| 401 - Unauthorized | Unauthorized access try with correct access. | |
| 402 - Request Failed | The parameters were valid but the request failed. | |
| 403 - Forbidden | The Application doesn't have permissions to perform the request. | |
| 404 - Not Found | The requested resource doesn't exist | |
| 500 - Server Errors | Something went wrong on ezto auth's end. (These are rare.) | |
| 503 - Server Errors | Service temporarily unavailable |