diff --git a/index.adoc b/index.adoc index 997bb27..bb829f4 100644 --- a/index.adoc +++ b/index.adoc @@ -686,6 +686,332 @@ ifdef::internal-generation[] endif::internal-generation[] +[.Authentication] +=== Authentication + + +[.getAuthenticationIdps] +==== getAuthenticationIdps + +`GET /authentication/idps` + +Get all authentication identity providers + +===== Description + + + + +// markup not found, no include::{specDir}authentication/idps/GET/spec.adoc[opts=optional] + + + +===== Parameters + + + + + + + +===== Return Type + +<> + + +===== Content Type + +* application/json + +===== Responses + +.HTTP Response Codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| Returns all authentication identity providers. +| <> + + +| 0 +| Returns a list of error messages. +| <> + +|=== + +===== Samples + + +// markup not found, no include::{snippetDir}authentication/idps/GET/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}authentication/idps/GET/http-response.adoc[opts=optional] + + + +// file not found, no * wiremock data link :authentication/idps/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}authentication/idps/GET/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +[.getAuthenticationSso] +==== getAuthenticationSso + +`GET /authentication/sso` + +Get authentication SSO configuration + +===== Description + + + + +// markup not found, no include::{specDir}authentication/sso/GET/spec.adoc[opts=optional] + + + +===== Parameters + + + + + + + +===== Return Type + +<> + + +===== Content Type + +* application/json + +===== Responses + +.HTTP Response Codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| Returns the authentication SSO configuration. +| <> + + +| 0 +| Returns a list of error messages. +| <> + +|=== + +===== Samples + + +// markup not found, no include::{snippetDir}authentication/sso/GET/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}authentication/sso/GET/http-response.adoc[opts=optional] + + + +// file not found, no * wiremock data link :authentication/sso/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}authentication/sso/GET/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +[.setAuthenticationIdps] +==== setAuthenticationIdps + +`PATCH /authentication/idps` + +Set all authentication identity providers + +===== Description + + + + +// markup not found, no include::{specDir}authentication/idps/PATCH/spec.adoc[opts=optional] + + + +===== Parameters + + +====== Body Parameter + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + +| AuthenticationIdpsBean +| <> +| - +| +| + +|=== + + + + + +===== Return Type + +<> + + +===== Content Type + +* application/json + +===== Responses + +.HTTP Response Codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| Returns the set authentication identity providers. +| <> + + +| 0 +| Returns a list of error messages. +| <> + +|=== + +===== Samples + + +// markup not found, no include::{snippetDir}authentication/idps/PATCH/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}authentication/idps/PATCH/http-response.adoc[opts=optional] + + + +// file not found, no * wiremock data link :authentication/idps/PATCH/PATCH.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}authentication/idps/PATCH/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +[.setAuthenticationSso] +==== setAuthenticationSso + +`PATCH /authentication/sso` + +Set authentication SSO configuration + +===== Description + + + + +// markup not found, no include::{specDir}authentication/sso/PATCH/spec.adoc[opts=optional] + + + +===== Parameters + + +====== Body Parameter + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + +| AuthenticationSsoBean +| <> +| - +| +| + +|=== + + + + + +===== Return Type + +<> + + +===== Content Type + +* application/json + +===== Responses + +.HTTP Response Codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| Returns the set authentication SSO configuration. +| <> + + +| 0 +| Returns a list of error messages. +| <> + +|=== + +===== Samples + + +// markup not found, no include::{snippetDir}authentication/sso/PATCH/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}authentication/sso/PATCH/http-response.adoc[opts=optional] + + + +// file not found, no * wiremock data link :authentication/sso/PATCH/PATCH.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}authentication/sso/PATCH/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + [.Directories] === Directories @@ -2703,6 +3029,141 @@ endif::internal-generation[] |=== +[#AuthenticationIdpOidcBean] +=== _AuthenticationIdpOidcBean_ + + + +[.fields-AuthenticationIdpOidcBean] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| id +| +| Long +| +| int64 + +| name +| +| String +| +| + +| enabled +| +| Boolean +| +| + +| url +| +| String +| +| + +| enableRememberMe +| +| Boolean +| +| + +| buttonText +| +| String +| +| + +| clientId +| +| String +| +| + +| clientSecret +| +| String +| +| + +| usernameClaim +| +| String +| +| + +| additionalScopes +| +| List of <> +| +| + +| discoveryEnabled +| +| Boolean +| +| + +| authorizationEndpoint +| +| String +| +| + +| tokenEndpoint +| +| String +| +| + +| userInfoEndpoint +| +| String +| +| + +|=== + + +[#AuthenticationIdpsBean] +=== _AuthenticationIdpsBean_ + + + +[.fields-AuthenticationIdpsBean] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| authenticationIdpBeans +| +| List of <> +| +| + +|=== + + +[#AuthenticationSsoBean] +=== _AuthenticationSsoBean_ + + + +[.fields-AuthenticationSsoBean] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| showOnLogin +| +| Boolean +| +| + +|=== + + [#DirectoriesBean] === _DirectoriesBean_ diff --git a/pom.xml b/pom.xml index 50a2186..51defee 100644 --- a/pom.xml +++ b/pom.xml @@ -12,7 +12,7 @@ 4.0.0 confapi-jira-plugin - 0.1.0-SNAPSHOT + 0.1.0 atlassian-plugin ConfAPI for Jira