Oidc-Clients
Endpoints for Oidc-Clients
Endpoints for Oidc-Clients
GET/api/v1/setting/oidc-clients
Authentication: Bearer token (JWT)
namestringRequired when parent is presentapplicationTypestringRequired when parent is present"web", "native"platformstringRequired when parent is presentclientIdstringRequired when parent is presentclientSecretstringRequired when parent is presentcallbackUrlstringRequired when parent is presentpostLogoutRedirectUris[
{
"name": "string",
"applicationType": "web",
"platform": "string",
"clientId": "string",
"clientSecret": "<clientSecret>",
"callbackUrl": "string",
"postLogoutRedirectUris": [],
"disablePKCE": true,
"debugMode": true,
"disableUserCreation": true,
"deviceFlowEnabled": true,
"publicClient": true,
"tenant": {
"additionalFeatures": [],
"disabledFeatures": [],
"taxRates": [],
"products": [],
"users": [],
"members": [],
"roles": [],
"subscriptionPlans": [],
"packages": [],
"invoices": [],
"orders": [],
"paymentProviders": [],
"newslettersProviderConfig": [],
"paymentProviderConfigs": [],
"oidcClients": [],
"oauthProviders": [],
"activityLogs": [],
"m2m_api_clients": [],
"customProperties": [],
"consents": [],
"communicationTemplates": [],
"additionalHostnames": [],
"exportHistory": [],
"arReportHistory": [],
"mypageCardsSettings": [],
"webhooks": [],
"customOrders": [],
"customOrderSources": [],
"brandKits": [],
"communicationReceivers": [],
"metaData": {}
},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
}
]unauthorized
This response has no body.
forbiddenResource
messageCodestringRequiredmessagestringerrorsarray of FieldErrorRequired7 fieldserrorscurlcurl https://api.subrite.no/api/v1/setting/oidc-clients \
--header 'Authorization: Bearer <token>'POST/api/v1/setting/oidc-clients
Authentication: Bearer token (JWT)
application/jsonnamestringRequiredapplicationTypestringRequiredplatformstringRequiredGET/api/v1/setting/oidc-clients/{id}
Authentication: Bearer token (JWT)
idnumberRequiredSame fields as .
DELETE/api/v1/setting/oidc-clients/{id}
Authentication: Bearer token (JWT)
idnumberRequiredThis response has no body.
PATCH/api/v1/setting/oidc-clients/{id}
Authentication: Bearer token (JWT)
idnumberRequiredapplication/jsonnamestringOptionalapplicationTypestringPATCH/api/v1/setting/oidc-clients/{id}/secret
Authentication: Bearer token (JWT)
idnumberRequiredarray of stringdisablePKCEbooleanRequired when parent is presentdebugModebooleanRequired when parent is presentdisableUserCreationbooleanRequired when parent is presentdeviceFlowEnabledbooleanRequired when parent is presentpublicClientbooleanRequired when parent is presenttenantTenantRequired when parent is presentNested fields omitted: field limit.idnumberRequired when parent is presentcreatedAtstring (date-time)Required when parent is presentupdatedAtstring (date-time)Required when parent is presentdeletedAtstring (date-time)Required when parent is presentmetaDataobjectRequired when parent is presentfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}callbackUrlstringpostLogoutRedirectUrisarray of stringRequiredminItems: 1disablePKCEbooleanRequireddebugModebooleanOptionalfalsedisableUserCreationbooleanOptionalfalsedeviceFlowEnabledbooleanOptionalfalsepublicClientbooleanOptionalfalse{
"name": "string",
"applicationType": "string",
"platform": "string",
"callbackUrl": "string",
"postLogoutRedirectUris": [
"string"
],
"disablePKCE": true,
"debugMode": false,
"disableUserCreation": false,
"deviceFlowEnabled": false,
"publicClient": false
}namestringRequiredapplicationTypestringRequired"web", "native"platformstringRequiredclientIdstringRequiredclientSecretstringRequiredcallbackUrlstringRequiredpostLogoutRedirectUrisarray of stringRequireddisablePKCEbooleanRequireddebugModebooleanRequireddisableUserCreationbooleanRequireddeviceFlowEnabledbooleanRequiredpublicClientbooleanRequiredtenantTenantRequiredNested fields omitted: field limit.idnumberRequiredcreatedAtstring (date-time)RequiredupdatedAtstring (date-time)RequireddeletedAtstring (date-time)RequiredmetaDataobjectRequiredBody validation failed
messageCodestringRequired"badRequest"messagestringerrorsarray of FieldErrorunauthorized
This response has no body.
The user lacks access to account settings, or sets deviceFlowEnabled or publicClient without being a system admin
messageCodestringRequired"forbiddenResource", "oidcClientFlagRequiresSystemAdmin"messagestringinternalServerError
Same fields as Get all OIDC clients of a tenant (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl https://api.subrite.no/api/v1/setting/oidc-clients \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "string",
"applicationType": "string",
"platform": "string",
"callbackUrl": "string",
"postLogoutRedirectUris": [
"string"
],
"disablePKCE": true,
"debugMode": false,
"disableUserCreation": false,
"deviceFlowEnabled": false,
"publicClient": false
}'{
"name": "string",
"applicationType": "web",
"platform": "string",
"clientId": "string",
"clientSecret": "<clientSecret>",
"callbackUrl": "string",
"postLogoutRedirectUris": [
"string"
],
"disablePKCE": true,
"debugMode": true,
"disableUserCreation": true,
"deviceFlowEnabled": true,
"publicClient": true,
"tenant": {
"market": "NO",
"productName": "enterprise",
"additionalFeatures": [],
"disabledFeatures": [],
"name": "string",
"isActive": true,
"defaultLanguage": "en",
"hostName": "string",
"logo": "string",
"favicon": "string",
"authLogo": "string",
"authLogoHeight": 0,
"siteUrl": "string",
"termsUrl": "string",
"privacyUrl": "string",
"gtm": "string",
"taxRates": [],
"smsOtp": true,
"emailProvider": "brevo",
"tenantContact": "string",
"registeredBusinessNo": "string",
"bankAccountNo": "string",
"swiftCode": "string",
"iban": "<iban>",
"defaultLogoutURL": "string",
"postalAddress": "<postalAddress>",
"otpTemplateId": {},
"smsSenderId": 0,
"emailSenderId": 0,
"smsSender": {
"metaData": {}
},
"emailSender": {
"metaData": {}
},
"products": [],
"users": [],
"members": [],
"roles": [],
"subscriptionPlans": [],
"packages": [],
"invoices": [],
"orders": [],
"paymentProviders": [],
"newslettersProviderConfig": [],
"paymentProviderConfigs": [],
"oidcClients": [],
"oauthProviders": [],
"activityLogs": [],
"m2m_api_clients": [],
"customProperties": [],
"consents": [],
"preference": {
"inputFieldConfig": [],
"customFieldsOnMemberCard": [],
"customFieldsOnInvoice": [],
"visibleAdditionalFieldsOnMypage": [],
"metaData": {}
},
"settings": {
"aiResidency": {},
"metaData": {}
},
"communicationTemplates": [],
"additionalHostnames": [],
"exportHistory": [],
"arReportHistory": [],
"mypageCardsSettings": [],
"webhooks": [],
"customOrders": [],
"customOrderSources": [],
"brandKits": [],
"communicationReceivers": [],
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
}The id is not an integer
Same fields as Create a new OIDC client for a tenant (400).
{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all OIDC clients of a tenant (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}oidcClientNotFound
messageCodestringRequired"oidcClientNotFound"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is present{
"messageCode": "oidcClientNotFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/setting/oidc-clients/{id}' \
--header 'Authorization: Bearer <token>'application/jsonThe id is not an integer
Same fields as Create a new OIDC client for a tenant (400).
{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all OIDC clients of a tenant (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}oidcClientNotFound
Same fields as Find an OIDC client by Id (404).
{
"messageCode": "oidcClientNotFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/setting/oidc-clients/{id}' \
--request DELETE \
--header 'Authorization: Bearer <token>'platformstringOptionalcallbackUrlstringOptionalpostLogoutRedirectUrisarray of stringOptionalminItems: 1disablePKCEbooleanOptionaldebugModebooleanOptionalfalsedisableUserCreationbooleanOptionalfalsedeviceFlowEnabledbooleanOptionalfalsepublicClientbooleanOptionalfalse{
"name": "string",
"applicationType": "string",
"platform": "string",
"callbackUrl": "string",
"postLogoutRedirectUris": [
"string"
],
"disablePKCE": true,
"debugMode": false,
"disableUserCreation": false,
"deviceFlowEnabled": false,
"publicClient": false
}Same fields as Create a new OIDC client for a tenant (201).
{
"name": "string",
"applicationType": "web",
"platform": "string",
"clientId": "string",
"clientSecret": "<clientSecret>",
"callbackUrl": "string",
"postLogoutRedirectUris": [
"string"
],
"disablePKCE": true,
"debugMode": true,
"disableUserCreation": true,
"deviceFlowEnabled": true,
"publicClient": true,
"tenant": {
"market": "NO",
"productName": "enterprise",
"additionalFeatures": [],
"disabledFeatures": [],
"name": "string",
"isActive": true,
"defaultLanguage": "en",
"hostName": "string",
"logo": "string",
"favicon": "string",
"authLogo": "string",
"authLogoHeight": 0,
"siteUrl": "string",
"termsUrl": "string",
"privacyUrl": "string",
"gtm": "string",
"taxRates": [],
"smsOtp": true,
"emailProvider": "brevo",
"tenantContact": "string",
"registeredBusinessNo": "string",
"bankAccountNo": "string",
"swiftCode": "string",
"iban": "<iban>",
"defaultLogoutURL": "string",
"postalAddress": "<postalAddress>",
"otpTemplateId": {},
"smsSenderId": 0,
"emailSenderId": 0,
"smsSender": {
"metaData": {}
},
"emailSender": {
"metaData": {}
},
"products": [],
"users": [],
"members": [],
"roles": [],
"subscriptionPlans": [],
"packages": [],
"invoices": [],
"orders": [],
"paymentProviders": [],
"newslettersProviderConfig": [],
"paymentProviderConfigs": [],
"oidcClients": [],
"oauthProviders": [],
"activityLogs": [],
"m2m_api_clients": [],
"customProperties": [],
"consents": [],
"preference": {
"inputFieldConfig": [],
"customFieldsOnMemberCard": [],
"customFieldsOnInvoice": [],
"visibleAdditionalFieldsOnMypage": [],
"metaData": {}
},
"settings": {
"aiResidency": {},
"metaData": {}
},
"communicationTemplates": [],
"additionalHostnames": [],
"exportHistory": [],
"arReportHistory": [],
"mypageCardsSettings": [],
"webhooks": [],
"customOrders": [],
"customOrderSources": [],
"brandKits": [],
"communicationReceivers": [],
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
}Body validation failed, or the id is not an integer
Same fields as Create a new OIDC client for a tenant (400).
unauthorized
This response has no body.
The user lacks access to account settings, or changes deviceFlowEnabled or publicClient without being a system admin
Same fields as Create a new OIDC client for a tenant (403).
oidcClientNotFound
Same fields as Find an OIDC client by Id (404).
{
"messageCode": "oidcClientNotFound",
"message": "string",
"errors": [
{}
]
}internalServerError
Same fields as Get all OIDC clients of a tenant (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/setting/oidc-clients/{id}' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "string",
"applicationType": "string",
"platform": "string",
"callbackUrl": "string",
"postLogoutRedirectUris": [
"string"
],
"disablePKCE": true,
"debugMode": false,
"disableUserCreation": false,
"deviceFlowEnabled": false,
"publicClient": false
}'OidcClientSame fields as Create a new OIDC client for a tenant (201).
{
"name": "string",
"applicationType": "web",
"platform": "string",
"clientId": "string",
"clientSecret": "<clientSecret>",
"callbackUrl": "string",
"postLogoutRedirectUris": [
"string"
],
"disablePKCE": true,
"debugMode": true,
"disableUserCreation": true,
"deviceFlowEnabled": true,
"publicClient": true,
"tenant": {
"market": "NO",
"productName": "enterprise",
"additionalFeatures": [],
"disabledFeatures": [],
"name": "string",
"isActive": true,
"defaultLanguage": "en",
"hostName": "string",
"logo": "string",
"favicon": "string",
"authLogo": "string",
"authLogoHeight": 0,
"siteUrl": "string",
"termsUrl": "string",
"privacyUrl": "string",
"gtm": "string",
"taxRates": [],
"smsOtp": true,
"emailProvider": "brevo",
"tenantContact": "string",
"registeredBusinessNo": "string",
"bankAccountNo": "string",
"swiftCode": "string",
"iban": "<iban>",
"defaultLogoutURL": "string",
"postalAddress": "<postalAddress>",
"otpTemplateId": {},
"smsSenderId": 0,
"emailSenderId": 0,
"smsSender": {
"metaData": {}
},
"emailSender": {
"metaData": {}
},
"products": [],
"users": [],
"members": [],
"roles": [],
"subscriptionPlans": [],
"packages": [],
"invoices": [],
"orders": [],
"paymentProviders": [],
"newslettersProviderConfig": [],
"paymentProviderConfigs": [],
"oidcClients": [],
"oauthProviders": [],
"activityLogs": [],
"m2m_api_clients": [],
"customProperties": [],
"consents": [],
"preference": {
"inputFieldConfig": [],
"customFieldsOnMemberCard": [],
"customFieldsOnInvoice": [],
"visibleAdditionalFieldsOnMypage": [],
"metaData": {}
},
"settings": {
"aiResidency": {},
"metaData": {}
},
"communicationTemplates": [],
"additionalHostnames": [],
"exportHistory": [],
"arReportHistory": [],
"mypageCardsSettings": [],
"webhooks": [],
"customOrders": [],
"customOrderSources": [],
"brandKits": [],
"communicationReceivers": [],
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
}The id is not an integer
Same fields as Create a new OIDC client for a tenant (400).
{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all OIDC clients of a tenant (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}oidcClientNotFound
Same fields as Find an OIDC client by Id (404).
{
"messageCode": "oidcClientNotFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/setting/oidc-clients/{id}/secret' \
--request PATCH \
--header 'Authorization: Bearer <token>'{
"name": "string",
"applicationType": "web",
"platform": "string",
"clientId": "string",
"clientSecret": "<clientSecret>",
"callbackUrl": "string",
"postLogoutRedirectUris": [
"string"
],
"disablePKCE": true,
"debugMode": true,
"disableUserCreation": true,
"deviceFlowEnabled": true,
"publicClient": true,
"tenant": {
"market": "NO",
"productName": "enterprise",
"additionalFeatures": [],
"disabledFeatures": [],
"name": "string",
"isActive": true,
"defaultLanguage": "en",
"hostName": "string",
"logo": "string",
"favicon": "string",
"authLogo": "string",
"authLogoHeight": 0,
"siteUrl": "string",
"termsUrl": "string",
"privacyUrl": "string",
"gtm": "string",
"taxRates": [],
"smsOtp": true,
"emailProvider": "brevo",
"tenantContact": "string",
"registeredBusinessNo": "string",
"bankAccountNo": "string",
"swiftCode": "string",
"iban": "<iban>",
"defaultLogoutURL": "string",
"postalAddress": "<postalAddress>",
"otpTemplateId": {},
"smsSenderId": 0,
"emailSenderId": 0,
"smsSender": {
"metaData": {}
},
"emailSender": {
"metaData": {}
},
"products": [],
"users": [],
"members": [],
"roles": [],
"subscriptionPlans": [],
"packages": [],
"invoices": [],
"orders": [],
"paymentProviders": [],
"newslettersProviderConfig": [],
"paymentProviderConfigs": [],
"oidcClients": [],
"oauthProviders": [],
"activityLogs": [],
"m2m_api_clients": [],
"customProperties": [],
"consents": [],
"preference": {
"inputFieldConfig": [],
"customFieldsOnMemberCard": [],
"customFieldsOnInvoice": [],
"visibleAdditionalFieldsOnMypage": [],
"metaData": {}
},
"settings": {
"aiResidency": {},
"metaData": {}
},
"communicationTemplates": [],
"additionalHostnames": [],
"exportHistory": [],
"arReportHistory": [],
"mypageCardsSettings": [],
"webhooks": [],
"customOrders": [],
"customOrderSources": [],
"brandKits": [],
"communicationReceivers": [],
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
}errorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}errorsarray of FieldErrorRequirederrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "forbiddenResource",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "badRequest",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "forbiddenResource",
"message": "string",
"errors": [
{}
]
}