openapi: 3.2.0 info: title: Jans Config Database - LDAP configuration API contact: name: Contact url: https://github.com/JanssenProject/jans/discussions license: name: License url: https://github.com/JanssenProject/jans/blob/main/LICENSE version: OAS Version servers: - url: https://jans.local.io description: The Jans server tags: - name: Database - LDAP configuration paths: /api/v1/config/database/ldap: get: tags: - Database - LDAP configuration summary: Gets list of existing LDAP configurations description: Gets list of existing LDAP configurations. operationId: get-config-database-ldap responses: '200': description: Ok content: application/json: schema: type: array items: $ref: '#/components/schemas/GluuLdapConfiguration' examples: Response json example: description: Response json example value: "[\n {\n \"configId\": \"auth_ldap_server\",\n \"bindDN\": \"cn=directory manager\",\n \"bindPassword\": \"password==\",\n \"servers\": [\n \"jans.server:1636\"\n ],\n \"maxConnections\": 1000,\n \"useSSL\": true,\n \"baseDNs\": [\n \"ou=people,o=jans\"\n ],\n \"primaryKey\": \"uid\",\n \"localPrimaryKey\": \"uid\",\n \"useAnonymousBind\": false,\n \"enabled\": false,\n \"version\": 0,\n \"level\": 0\n }\n]\n" '401': description: Unauthorized '500': description: InternalServerError security: - oauth2: - https://jans.io/oauth/config/database/ldap.readonly - oauth2: - https://jans.io/oauth/config/database/ldap.write - oauth2: - https://jans.io/oauth/config/database.admin - oauth2: - https://jans.io/oauth/config/read-all - oauth2: - https://jans.io/oauth/config/write-all put: tags: - Database - LDAP configuration summary: Updates LDAP configuration operationId: put-config-database-ldap requestBody: description: GluuLdapConfiguration object content: application/json: schema: $ref: '#/components/schemas/GluuLdapConfiguration' examples: Request json example: description: Request json example value: "{\n \"configId\": \"auth_ldap_server\",\n \"bindDN\": \"cn=directory manager\",\n \"bindPassword\": \"axby+nlegh9DhpQ==\",\n \"servers\": [\n \"jans.server2:1636\"\n ],\n \"maxConnections\": 1000,\n \"useSSL\": true,\n \"baseDNs\": [\n \"ou=people,o=jans\"\n ],\n \"primaryKey\": \"uid\",\n \"localPrimaryKey\": \"uid\",\n \"useAnonymousBind\": false,\n \"enabled\": false,\n \"version\": 0,\n \"level\": 0\n}\n" responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/GluuLdapConfiguration' examples: Response json example: description: Response json example value: "{\n \"configId\": \"auth_ldap_server\",\n \"bindDN\": \"cn=directory manager\",\n \"bindPassword\": \"axby+nlegh9DhpQ==\",\n \"servers\": [\n \"jans.server2:1636\"\n ],\n \"maxConnections\": 1000,\n \"useSSL\": true,\n \"baseDNs\": [\n \"ou=people,o=jans\"\n ],\n \"primaryKey\": \"uid\",\n \"localPrimaryKey\": \"uid\",\n \"useAnonymousBind\": false,\n \"enabled\": false,\n \"version\": 0,\n \"level\": 0\n}\n" '401': description: Unauthorized '404': description: Not Found '500': description: InternalServerError security: - oauth2: - https://jans.io/oauth/config/database/ldap.write - oauth2: - https://jans.io/oauth/config/database.admin - oauth2: - https://jans.io/oauth/config/write-all post: tags: - Database - LDAP configuration summary: Adds a new LDAP configuration operationId: post-config-database-ldap requestBody: description: GluuLdapConfiguration object content: application/json: schema: $ref: '#/components/schemas/GluuLdapConfiguration' examples: Request json example: description: Request json example value: "{\n \"configId\": \"auth_ldap_server\",\n \"bindDN\": \"cn=directory manager\",\n \"bindPassword\": \"axby+nlegh9DhpQ==\",\n \"servers\": [\n \"jans.server2:1636\"\n ],\n \"maxConnections\": 1000,\n \"useSSL\": true,\n \"baseDNs\": [\n \"ou=people,o=jans\"\n ],\n \"primaryKey\": \"uid\",\n \"localPrimaryKey\": \"uid\",\n \"useAnonymousBind\": false,\n \"enabled\": false,\n \"version\": 0,\n \"level\": 0\n}\n" responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/GluuLdapConfiguration' examples: Response json example: description: Response json example value: "{\n \"configId\": \"auth_ldap_server\",\n \"bindDN\": \"cn=directory manager\",\n \"bindPassword\": \"axby+nlegh9DhpQ==\",\n \"servers\": [\n \"jans.server2:1636\"\n ],\n \"maxConnections\": 1000,\n \"useSSL\": true,\n \"baseDNs\": [\n \"ou=people,o=jans\"\n ],\n \"primaryKey\": \"uid\",\n \"localPrimaryKey\": \"uid\",\n \"useAnonymousBind\": false,\n \"enabled\": false,\n \"version\": 0,\n \"level\": 0\n}\n" '401': description: Unauthorized '406': description: Not Acceptable '500': description: InternalServerError security: - oauth2: - https://jans.io/oauth/config/database/ldap.write - oauth2: - https://jans.io/oauth/config/database.admin - oauth2: - https://jans.io/oauth/config/write-all /api/v1/config/database/ldap/{name}: get: tags: - Database - LDAP configuration summary: Gets an LDAP configuration by name description: Gets an LDAP configuration by name. operationId: get-config-database-ldap-by-name parameters: - name: name in: path description: Name of LDAP configuration required: true schema: type: string responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/GluuLdapConfiguration' examples: Response json example: description: Response json example value: "{\n \"configId\": \"auth_ldap_server\",\n \"bindDN\": \"cn=directory manager\",\n \"bindPassword\": \"axby+nlegh9DhpQ==\",\n \"servers\": [\n \"jans.server2:1636\"\n ],\n \"maxConnections\": 1000,\n \"useSSL\": true,\n \"baseDNs\": [\n \"ou=people,o=jans\"\n ],\n \"primaryKey\": \"uid\",\n \"localPrimaryKey\": \"uid\",\n \"useAnonymousBind\": false,\n \"enabled\": false,\n \"version\": 0,\n \"level\": 0\n}\n" '401': description: Unauthorized '500': description: InternalServerError security: - oauth2: - https://jans.io/oauth/config/database/ldap.readonly - oauth2: - https://jans.io/oauth/config/database/ldap.write - oauth2: - https://jans.io/oauth/config/database.admin - oauth2: - https://jans.io/oauth/config/read-all - oauth2: - https://jans.io/oauth/config/write-all delete: tags: - Database - LDAP configuration summary: Deletes an LDAP configuration operationId: delete-config-database-ldap-by-name parameters: - name: name in: path required: true schema: type: string responses: '204': description: No Content content: application/json: schema: $ref: '#/components/schemas/GluuLdapConfiguration' '401': description: Unauthorized '404': description: Not Found '500': description: InternalServerError security: - oauth2: - https://jans.io/oauth/config/database/ldap.delete - oauth2: - https://jans.io/oauth/config/database.admin - oauth2: - https://jans.io/oauth/config/delete-all patch: tags: - Database - LDAP configuration summary: Patches a LDAP configuration by name operationId: patch-config-database-ldap-by-name parameters: - name: name in: path description: Name of LDAP configuration required: true schema: type: string requestBody: description: JsonPatch object content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/JsonPatch' examples: Request json example: description: Request json example value: example/auth/database/ldap/ldap-patch responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/GluuLdapConfiguration' examples: Response json example: description: Response json example value: "{\n \"configId\": \"auth_ldap_server\",\n \"bindDN\": \"cn=directory manager\",\n \"bindPassword\": \"axby+nlegh9DhpQ==\",\n \"servers\": [\n \"jans.server2:1636\"\n ],\n \"maxConnections\": 1000,\n \"useSSL\": true,\n \"baseDNs\": [\n \"ou=people,o=jans\"\n ],\n \"primaryKey\": \"uid\",\n \"localPrimaryKey\": \"uid\",\n \"useAnonymousBind\": false,\n \"enabled\": false,\n \"version\": 0,\n \"level\": 0\n}\n" '401': description: Unauthorized '404': description: Not Found '500': description: InternalServerError security: - oauth2: - https://jans.io/oauth/config/database/ldap.write - oauth2: - https://jans.io/oauth/config/database.admin - oauth2: - https://jans.io/oauth/config/write-all /api/v1/config/database/ldap/test: post: tags: - Database - LDAP configuration summary: Tests an LDAP configuration operationId: post-config-database-ldap-test requestBody: description: GluuLdapConfiguration object content: application/json: schema: $ref: '#/components/schemas/GluuLdapConfiguration' examples: Request json example: description: Request json example value: "[{ \"op\": \"replace\", \"path\": \"/maxConnections\", \"value\":800}] \n" responses: '200': description: Ok content: application/json: schema: type: boolean description: boolean value true if successful '401': description: Unauthorized '500': description: InternalServerError security: - oauth2: - https://jans.io/oauth/config/database/ldap.readonly - oauth2: - https://jans.io/oauth/config/database/ldap.write - oauth2: - https://jans.io/oauth/config/database.admin - oauth2: - https://jans.io/oauth/config/read-all components: schemas: JsonPatch: type: object GluuLdapConfiguration: type: object properties: configId: type: string bindDN: type: string bindPassword: type: string servers: type: array items: type: string maxConnections: type: integer format: int32 useSSL: type: boolean baseDNs: type: array items: type: string primaryKey: type: string localPrimaryKey: type: string useAnonymousBind: type: boolean enabled: type: boolean version: type: integer format: int32 level: type: integer format: int32 securitySchemes: oauth2: type: oauth2 flows: clientCredentials: tokenUrl: https://{op-hostname}/.../token scopes: https://jans.io/oauth/jans-auth-server/config/properties.readonly: View Auth Server properties related information https://jans.io/oauth/jans-auth-server/config/properties.write: Manage Auth Server properties related information https://jans.io/oauth/config/attributes.readonly: View attribute related information https://jans.io/oauth/config/attributes.write: Manage attribute related information https://jans.io/oauth/config/attributes.delete: Delete attribute related information https://jans.io/oauth/config/acrs.readonly: View ACRS related information https://jans.io/oauth/config/acrs.write: Manage ACRS related information https://jans.io/oauth/config/database/ldap.readonly: View LDAP database related information https://jans.io/oauth/config/database/ldap.write: Manage LDAP database related information https://jans.io/oauth/config/database/ldap.delete: Delete LDAP database related information https://jans.io/oauth/config/scripts.readonly: View cache scripts information https://jans.io/oauth/config/scripts.write: Manage scripts related information https://jans.io/oauth/config/scripts.delete: Delete scripts related information https://jans.io/oauth/config/cache.readonly: View cache related information https://jans.io/oauth/config/cache.write: Manage cache related information https://jans.io/oauth/config/smtp.readonly: View SMTP related information https://jans.io/oauth/config/smtp.write: Manage SMTP related information https://jans.io/oauth/config/smtp.delete: Delete SMTP related information https://jans.io/oauth/config/logging.readonly: View logging related information https://jans.io/oauth/config/logging.write: Manage logging related information https://jans.io/oauth/config/jwks.readonly: View JWKS related information https://jans.io/oauth/config/jwks.write: Manage JWKS related information https://jans.io/oauth/config/jwks.delete: Delete JWKS related information https://jans.io/oauth/config/openid/clients.readonly: View clients related information https://jans.io/oauth/config/openid/clients.write: Manage clients related information https://jans.io/oauth/config/openid/clients.delete: Delete clients related information https://jans.io/oauth/config/scopes.readonly: View scope related information https://jans.io/oauth/config/scopes.write: Manage scope related information https://jans.io/oauth/config/scopes.delete: Delete scope related information https://jans.io/oauth/config/stats.readonly: View server with basic statistic https://jans.io/oauth/config/organization.readonly: View organization configuration information https://jans.io/oauth/config/organization.write: Manage organization configuration information https://jans.io/oauth/config/agama.readonly: View Agama Flow related information https://jans.io/oauth/config/agama.write: Manage Agama Flow related information https://jans.io/oauth/config/agama.delete: Delete Agama Flow related information https://jans.io/oauth/jans-auth-server/session.readonly: View Session related information https://jans.io/oauth/jans-auth-server/session.delete: Delete Session information https://jans.io/oauth/config/read-all: Super admin read access to all configuration resources https://jans.io/oauth/config/write-all: Super admin write access to all configuration resources https://jans.io/oauth/config/delete-all: Super admin delete access to all configuration resources https://jans.io/oauth/config/openid/openid.readonly: View OpenID functionality https://jans.io/oauth/config/openid/openid.write: Manage OpenID functionality https://jans.io/oauth/config/openid/openid.delete: Delete OpenID functionality https://jans.io/oauth/config/uma.readonly: View UMA functionality https://jans.io/oauth/config/uma.write: Manage UMA functionality https://jans.io/oauth/config/uma.delete: Delete UMA functionality https://jans.io/oauth/config/plugin.readonly: View Plugin information https://jans.io/oauth/config/properties.readonly: View Config-API related configuration properties https://jans.io/oauth/config/properties.write: Manage Config-API related configuration properties https://jans.io/oauth/client/authorizations.readonly: View ClientAuthorizations https://jans.io/oauth/client/authorizations.delete: Revoke ClientAuthorizations https://jans.io/oauth/config/asset.readonly: View Jans Assets https://jans.io/oauth/config/asset.write: Manage Jans Assets https://jans.io/oauth/config/asset.delete: Delete Jans Assets https://jans.io/oauth/config/token.readonly: View Token details https://jans.io/oauth/config/token.write: Manage Token details https://jans.io/oauth/config/token.delete: Delete Token details https://jans.io/oauth/config/data.readonly: View Config-API related data https://jans.io/oauth/config/ssa.readonly: View SSA details https://jans.io/oauth/config/ssa.write: Manage SSA details https://jans.io/oauth/config/ssa.delete: Delete SSA details https://jans.io/oauth/jans-auth-server/config/properties.admin: Admin scope for Auth Server properties https://jans.io/oauth/config/attributes.admin: Admin for Attribute management https://jans.io/oauth/config/acrs.admin: Admin for ACRS management https://jans.io/oauth/config/database.admin: Admin for Database config management https://jans.io/oauth/config/scripts.admin: Admin for Scripts management https://jans.io/oauth/config/cache.admin: Admin for Cache management https://jans.io/oauth/config/message.admin: Admin for Message management https://jans.io/oauth/config/smtp.admin: Admin for SMTP management https://jans.io/oauth/config/logging.admin: Admin for Logging management https://jans.io/oauth/config/jwks.admin: Admin for JWKS management https://jans.io/oauth/config/openid/clients.admin: Admin for clients management https://jans.io/oauth/config/token.admin: Admin for Token management https://jans.io/oauth/config/scopes.admin: Admin for scope management https://jans.io/oauth/config/stats.admin: Admin for statistic management https://jans.io/oauth/config/organization.admin: Admin for organization configuration management https://jans.io/oauth/config/agama.admin: Admin for Agama flow management https://jans.io/oauth/jans-auth-server/session.admin: Admin for Session management https://jans.io/oauth/config/uma.admin: Admin for UMA management https://jans.io/oauth/config/plugin.admin: Admin for Plugin management https://jans.io/oauth/config/properties.admin: Admin for Config-API management https://jans.io/oauth/client/authorizations.admin: Admin for Client Authorizations management https://jans.io/oauth/config/asset.admin: Admin for Jans Assets management https://jans.io/auth/ssa.admin: Admin for SSA management https://jans.io/oauth/config/health.admin: Admin for Health API management