Get all access tokens associated with the given project.
string
Requirednumber
number
A response containing a page of access tokens and associated details.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/access-tokens/latest/projects/{projectKey}' \
--header 'Accept: application/json;charset=UTF-8'Create an access token for the project according to the given request.
string
RequiredThe request containing the details of the access token to create.
integer
string
array<string>
A response containing the raw access token and associated details.
1
2
3
4
5
6
7
8
9
10
11
12
curl --request PUT \
--url 'http://{baseurl}/rest/access-tokens/latest/projects/{projectKey}' \
--header 'Accept: application/json;charset=UTF-8' \
--header 'Content-Type: application/json' \
--data '{
"expiryDays": 2154,
"name": "My access token",
"permissions": [
"REPO_ADMIN",
"PROJECT_READ"
]
}'Get all access tokens associated with the given repository.
string
Requiredstring
Requirednumber
number
A response containing a page of access tokens and associated details.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}' \
--header 'Accept: application/json;charset=UTF-8'Create an access token for the repository according to the given request.
string
Requiredstring
RequiredThe request containing the details of the access token to create.
integer
string
array<string>
A response containing the raw access token and associated details.
1
2
3
4
5
6
7
8
9
10
11
12
curl --request PUT \
--url 'http://{baseurl}/rest/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}' \
--header 'Accept: application/json;charset=UTF-8' \
--header 'Content-Type: application/json' \
--data '{
"expiryDays": 2154,
"name": "My access token",
"permissions": [
"REPO_ADMIN",
"PROJECT_READ"
]
}'Get the access token identified by the given ID.
string
Requiredstring
Requiredstring
RequiredA response containing the access token and associated details.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}/{tokenId}' \
--header 'Accept: application/json;charset=UTF-8'Modify an access token according to the given request. Any fields not specified will not be altered.
string
Requiredstring
Requiredstring
RequiredThe request containing the details of the access token to modify
integer
string
array<string>
A response containing the updated access token and associated details.
1
2
3
4
5
6
7
8
9
10
11
12
curl --request POST \
--url 'http://{baseurl}/rest/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}/{tokenId}' \
--header 'Accept: application/json;charset=UTF-8' \
--header 'Content-Type: application/json' \
--data '{
"expiryDays": 2154,
"name": "My access token",
"permissions": [
"REPO_ADMIN",
"PROJECT_READ"
]
}'Delete the access token identified by the given ID.
string
Requiredstring
Requiredstring
RequiredAn empty response indicating that the token has been deleted.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/access-tokens/latest/projects/{projectKey}/repos/{repositorySlug}/{tokenId}'Get the access token identified by the given ID.
string
Requiredstring
RequiredA response containing the access token and associated details.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/access-tokens/latest/projects/{projectKey}/{tokenId}' \
--header 'Accept: application/json;charset=UTF-8'Modify an access token according to the given request. Any fields not specified will not be altered.
string
Requiredstring
RequiredThe request containing the details of the access token to modify
integer
string
array<string>
A response containing the updated access token and associated details.
1
2
3
4
5
6
7
8
9
10
11
12
curl --request POST \
--url 'http://{baseurl}/rest/access-tokens/latest/projects/{projectKey}/{tokenId}' \
--header 'Accept: application/json;charset=UTF-8' \
--header 'Content-Type: application/json' \
--data '{
"expiryDays": 2154,
"name": "My access token",
"permissions": [
"REPO_ADMIN",
"PROJECT_READ"
]
}'Delete the access token identified by the given ID.
string
Requiredstring
RequiredAn empty response indicating that the token has been deleted.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/access-tokens/latest/projects/{projectKey}/{tokenId}'Get all access tokens associated with the given user.
string
Requirednumber
number
A response containing a page of access tokens and associated details.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/access-tokens/latest/users/{userSlug}' \
--header 'Accept: application/json;charset=UTF-8'Create an access token for the user according to the given request.
string
RequiredThe request containing the details of the access token to create.
integer
string
array<string>
A response containing the raw access token and associated details.
1
2
3
4
5
6
7
8
9
10
11
12
curl --request PUT \
--url 'http://{baseurl}/rest/access-tokens/latest/users/{userSlug}' \
--header 'Accept: application/json;charset=UTF-8' \
--header 'Content-Type: application/json' \
--data '{
"expiryDays": 2154,
"name": "My access token",
"permissions": [
"REPO_ADMIN",
"PROJECT_READ"
]
}'Get the access token identified by the given ID.
string
Requiredstring
RequiredA response containing the access token and associated details.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/access-tokens/latest/users/{userSlug}/{tokenId}' \
--header 'Accept: application/json;charset=UTF-8'Modify an access token according to the given request. Any fields not specified will not be altered.
string
Requiredstring
RequiredThe request containing the details of the access token to modify
integer
string
array<string>
A response containing the updated access token and associated details.
1
2
3
4
5
6
7
8
9
10
11
12
curl --request POST \
--url 'http://{baseurl}/rest/access-tokens/latest/users/{userSlug}/{tokenId}' \
--header 'Accept: application/json;charset=UTF-8' \
--header 'Content-Type: application/json' \
--data '{
"expiryDays": 2154,
"name": "My access token",
"permissions": [
"REPO_ADMIN",
"PROJECT_READ"
]
}'Delete the access token identified by the given ID.
string
Requiredstring
RequiredAn empty response indicating that the token has been deleted.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/access-tokens/latest/users/{userSlug}/{tokenId}'Retrieves the access keys for the repository identified in the URL.
string
Requiredstring
Requiredstring
string
string
string
number
number
A single page of access keys for the repository.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh' \
--header 'Accept: application/json;charset=UTF-8'Register a new SSH key and grants access to the repository identified in the URL.
string
Requiredstring
Requiredobject
string
object
object
The newly created access key.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
curl --request POST \
--url 'http://{baseurl}/rest/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh' \
--header 'Accept: application/json;charset=UTF-8' \
--header 'Content-Type: application/json' \
--data '{
"key": {
"algorithmType": "<string>",
"bitLength": 2154,
"expiryDays": 30,
"label": "me@127.0.0.1",
"text": "ssh-rsa AAAAB3... me@127.0.0.1"
},
"permission": "USER_ADMIN",
"project": {
"avatar": "<string>",
"avatarUrl": "<string>",
"key": "PRJ",
"links": {}
},
"repository": {
"defaultBranch": "main",
"links": {},
"name": "My repo",
"project": {
"avatar": "<string>",
"avatarUrl": "<string>",
"key": "PRJ",
"links": {}
},
"scmId": "git",
"slug": "my-repo"
}
}'Retrieves the access key for the SSH key with id keyId on the repository identified in the URL.
string
Requiredstring
Requiredstring
RequiredThe access key for the repository and SSH key with ID keyId.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh/{keyId}' \
--header 'Accept: application/json;charset=UTF-8'Remove an existing access key for the repository identified in the URL. If the same SSH key is used as an access key for multiple projects or repositories, only the access to the repository identified in the URL will be revoked.
string
Requiredstring
Requiredstring
RequiredThe access key was deleted (or none was found matching the given id).
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh/{keyId}'Updates the permission granted to the specified SSH key to the repository identified in the URL.
string
Requiredstring
Requiredstring
Requiredstring
RequiredThe newly created access key.
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/keys/latest/projects/{projectKey}/repos/{repositorySlug}/ssh/{keyId}/permission/{permission}' \
--header 'Accept: application/json;charset=UTF-8'Retrieves the access keys for the project identified in the URL.
string
Requiredstring
string
number
number
A single page of access keys associated with the project.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/keys/latest/projects/{projectKey}/ssh' \
--header 'Accept: application/json;charset=UTF-8'Register a new SSH key and grants access to the project identified in the URL.
string
Requiredobject
string
object
object
The newly created access key.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
curl --request POST \
--url 'http://{baseurl}/rest/keys/latest/projects/{projectKey}/ssh' \
--header 'Accept: application/json;charset=UTF-8' \
--header 'Content-Type: application/json' \
--data '{
"key": {
"algorithmType": "<string>",
"bitLength": 2154,
"expiryDays": 30,
"label": "me@127.0.0.1",
"text": "ssh-rsa AAAAB3... me@127.0.0.1"
},
"permission": "USER_ADMIN",
"project": {
"avatar": "<string>",
"avatarUrl": "<string>",
"key": "PRJ",
"links": {}
},
"repository": {
"defaultBranch": "main",
"links": {},
"name": "My repo",
"project": {
"avatar": "<string>",
"avatarUrl": "<string>",
"key": "PRJ",
"links": {}
},
"scmId": "git",
"slug": "my-repo"
}
}'Retrieves the access key for the SSH key with id keyId on the project identified in the URL.
string
Requiredstring
RequiredThe access key for the repository and SSH key with ID keyId.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/keys/latest/projects/{projectKey}/ssh/{keyId}' \
--header 'Accept: application/json;charset=UTF-8'Remove an existing access key for the project identified in the URL. If the same SSH key is used as an access key for multiple projects or repositories, only the access to the project identified in the URL will be revoked.
string
Requiredstring
RequiredThe access key was deleted (or none was found matching the given id).
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/keys/latest/projects/{projectKey}/ssh/{keyId}'Updates the permission granted to the specified SSH key to the project identified in the URL.
string
Requiredstring
Requiredstring
RequiredThe newly created access key.
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/keys/latest/projects/{projectKey}/ssh/{keyId}/permission/{permission}' \
--header 'Accept: application/json;charset=UTF-8'Remove an existing access key for the projects and repositories in the submitted entity. If the same SSH key is used as an access key for multiple projects or repositories not supplied, only the access to the projects or repositories identified will be revoked.
string
RequiredRestProject
RestRepository
The access keys were deleted (or none was found matching the given id and repositories or projects).
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
curl --request DELETE \
--url 'http://{baseurl}/rest/keys/latest/ssh/{keyId}' \
--header 'Content-Type: application/json' \
--data '{
"projects": {
"avatar": "<string>",
"avatarUrl": "<string>",
"key": "PRJ",
"links": {}
},
"repositories": {
"defaultBranch": "main",
"links": {},
"name": "My repo",
"project": {
"avatar": "<string>",
"avatarUrl": "<string>",
"key": "PRJ",
"links": {}
},
"scmId": "git",
"slug": "my-repo"
}
}'Retrieves all project-related access keys for the SSH key with id keyId. If the current user is not an admin any of the projects the key provides access to, none are returned.
integer
RequiredThe SSH key with ID keyId.
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/keys/latest/ssh/{keyId}/projects' \
--header 'Accept: application/json;charset=UTF-8'Retrieves all repository-related access keys for the SSH key with id keyId. If the current user is not an admin of any of the projects the key provides access to, none are returned.
string
Requiredstring
The SSH key with ID keyId.
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/keys/latest/ssh/{keyId}/repos' \
--header 'Accept: application/json;charset=UTF-8'Retrieve a page of SSH keys.
string
string
number
number
A page of SSH keys.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/ssh/latest/keys' \
--header 'Accept: application/json;charset=UTF-8'Add a new SSH key to a supplied user.
RestSshKey
string
integer
integer
string
string
The newly created SSH key.
1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
--url 'http://{baseurl}/rest/ssh/latest/keys' \
--header 'Accept: application/json;charset=UTF-8' \
--header 'Content-Type: application/json' \
--data '{
"algorithmType": "<string>",
"bitLength": 2154,
"expiryDays": 30,
"label": "me@127.0.0.1",
"text": "ssh-rsa AAAAB3... me@127.0.0.1"
}'Delete all SSH keys for a supplied user.
string
string
The SSH keys matching the supplied user were deleted.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/ssh/latest/keys'Retrieve an SSH key by keyId
The authenticated user must have ADMIN permission or higher to call this resource.
string
RequiredAn SSH key.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/ssh/latest/keys/{keyId}' \
--header 'Accept: application/json;charset=UTF-8'Delete an SSH key.
The authenticated user must have ADMIN permission or higher to call this resource.
string
RequiredThe SSH key matching the supplied id was deleted or did not exist.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/ssh/latest/keys/{keyId}'Gets the SSH settings from the upstream.
This request has no parameters.
The ssh settings from upstream
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/ssh/latest/settings' \
--header 'Accept: application/json;charset=UTF-8'Returns a page of configured IdPs. This endpoint makes no guarantees to ordering besides the ordering being consistent.
number
number
A page of configured IdPs.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/authconfig/latest/idps' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{
"isLastPage": true,
"limit": 25,
"results": [
{
"additional-scopes": [
"<string>"
],
"authorization-endpoint": "<string>",
"buttonText": "<string>",
"certificate": "<string>",
"client-id": "<string>",
"client-secret": "<string>",
"crowd-url": "<string>",
"discovery-enabled": true,
"enable-remember-me": true,
"enabled": true,
"id": 2154,
"idp-type": "GENERIC",
"include-customer-logins": true,
"issuer-url": "<string>",
"jit-configuration": {
"additional-openid-scopes": [
"<string>"
],
"mapping-display-name": "<string>",
"mapping-email": "<string>",
"mapping-groups": "<string>",
"user-provisioning-enabled": true
},
"last-updated": "<string>",
"name": "<string>",
"sso-issuer": "<string>",
"sso-type": "NONE",
"sso-url": "<string>",
"token-endpoint": "<string>",
"userinfo-endpoint": "<string>",
"username-attribute": "<string>",
"username-claim": "<string>"
}
],
"size": 1,
"start": 2154
}Creates a new IdP configuration.
The configuration of the new IdP to add. The ID must be null.
array<string>
string
string
string
string
string
string
boolean
boolean
boolean
The newly created IdP configuration.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
curl --request POST \
--url 'http://{baseurl}/rest/authconfig/latest/idps' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"additional-scopes": [
"<string>"
],
"authorization-endpoint": "<string>",
"buttonText": "<string>",
"certificate": "<string>",
"client-id": "<string>",
"client-secret": "<string>",
"crowd-url": "<string>",
"discovery-enabled": true,
"enable-remember-me": true,
"enabled": true,
"id": 2154,
"idp-type": "GENERIC",
"include-customer-logins": true,
"issuer-url": "<string>",
"jit-configuration": {
"additional-openid-scopes": [
"<string>"
],
"mapping-display-name": "<string>",
"mapping-email": "<string>",
"mapping-groups": "<string>",
"user-provisioning-enabled": true
},
"last-updated": "<string>",
"name": "<string>",
"sso-issuer": "<string>",
"sso-type": "NONE",
"sso-url": "<string>",
"token-endpoint": "<string>",
"userinfo-endpoint": "<string>",
"username-attribute": "<string>",
"username-claim": "<string>"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
"additional-scopes": [
"<string>"
],
"authorization-endpoint": "<string>",
"buttonText": "<string>",
"certificate": "<string>",
"client-id": "<string>",
"client-secret": "<string>",
"crowd-url": "<string>",
"discovery-enabled": true,
"enable-remember-me": true,
"enabled": true,
"id": 2154,
"idp-type": "GENERIC",
"include-customer-logins": true,
"issuer-url": "<string>",
"jit-configuration": {
"additional-openid-scopes": [
"<string>"
],
"mapping-display-name": "<string>",
"mapping-email": "<string>",
"mapping-groups": "<string>",
"user-provisioning-enabled": true
},
"last-updated": "<string>",
"name": "<string>",
"sso-issuer": "<string>",
"sso-type": "NONE",
"sso-url": "<string>",
"token-endpoint": "<string>",
"userinfo-endpoint": "<string>",
"username-attribute": "<string>",
"username-claim": "<string>"
}Returns the configuration for the IdP that matches the given ID.
string
RequiredThe configuration for the given IdP.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/authconfig/latest/idps/{id}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
"additional-scopes": [
"<string>"
],
"authorization-endpoint": "<string>",
"buttonText": "<string>",
"certificate": "<string>",
"client-id": "<string>",
"client-secret": "<string>",
"crowd-url": "<string>",
"discovery-enabled": true,
"enable-remember-me": true,
"enabled": true,
"id": 2154,
"idp-type": "GENERIC",
"include-customer-logins": true,
"issuer-url": "<string>",
"jit-configuration": {
"additional-openid-scopes": [
"<string>"
],
"mapping-display-name": "<string>",
"mapping-email": "<string>",
"mapping-groups": "<string>",
"user-provisioning-enabled": true
},
"last-updated": "<string>",
"name": "<string>",
"sso-issuer": "<string>",
"sso-type": "NONE",
"sso-url": "<string>",
"token-endpoint": "<string>",
"userinfo-endpoint": "<string>",
"username-attribute": "<string>",
"username-claim": "<string>"
}Removes the configuration for the IdP that matches the given ID.
string
RequiredThe IdP configuration was successfully deleted.
1
2
3
curl --request DELETE \
--url 'http://{baseurl}/rest/authconfig/latest/idps/{id}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
"additional-scopes": [
"<string>"
],
"authorization-endpoint": "<string>",
"buttonText": "<string>",
"certificate": "<string>",
"client-id": "<string>",
"client-secret": "<string>",
"crowd-url": "<string>",
"discovery-enabled": true,
"enable-remember-me": true,
"enabled": true,
"id": 2154,
"idp-type": "GENERIC",
"include-customer-logins": true,
"issuer-url": "<string>",
"jit-configuration": {
"additional-openid-scopes": [
"<string>"
],
"mapping-display-name": "<string>",
"mapping-email": "<string>",
"mapping-groups": "<string>",
"user-provisioning-enabled": true
},
"last-updated": "<string>",
"name": "<string>",
"sso-issuer": "<string>",
"sso-type": "NONE",
"sso-url": "<string>",
"token-endpoint": "<string>",
"userinfo-endpoint": "<string>",
"username-attribute": "<string>",
"username-claim": "<string>"
}Updates the configuration for the IdP that matches the given ID. Only the provided properties will be applied to the IdP configuration.
string
RequiredA request containing the IdP configuration to update. The ID must either be null or equal to the ID specified in the path.
array<string>
string
string
string
string
string
string
boolean
boolean
boolean
The updated configuration for the given IdP.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
curl --request PATCH \
--url 'http://{baseurl}/rest/authconfig/latest/idps/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"additional-scopes": [
"<string>"
],
"authorization-endpoint": "<string>",
"buttonText": "<string>",
"certificate": "<string>",
"client-id": "<string>",
"client-secret": "<string>",
"crowd-url": "<string>",
"discovery-enabled": true,
"enable-remember-me": true,
"enabled": true,
"id": 2154,
"idp-type": "GENERIC",
"include-customer-logins": true,
"issuer-url": "<string>",
"jit-configuration": {
"additional-openid-scopes": [
"<string>"
],
"mapping-display-name": "<string>",
"mapping-email": "<string>",
"mapping-groups": "<string>",
"user-provisioning-enabled": true
},
"last-updated": "<string>",
"name": "<string>",
"sso-issuer": "<string>",
"sso-type": "NONE",
"sso-url": "<string>",
"token-endpoint": "<string>",
"userinfo-endpoint": "<string>",
"username-attribute": "<string>",
"username-claim": "<string>"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
"additional-scopes": [
"<string>"
],
"authorization-endpoint": "<string>",
"buttonText": "<string>",
"certificate": "<string>",
"client-id": "<string>",
"client-secret": "<string>",
"crowd-url": "<string>",
"discovery-enabled": true,
"enable-remember-me": true,
"enabled": true,
"id": 2154,
"idp-type": "GENERIC",
"include-customer-logins": true,
"issuer-url": "<string>",
"jit-configuration": {
"additional-openid-scopes": [
"<string>"
],
"mapping-display-name": "<string>",
"mapping-email": "<string>",
"mapping-groups": "<string>",
"user-provisioning-enabled": true
},
"last-updated": "<string>",
"name": "<string>",
"sso-issuer": "<string>",
"sso-type": "NONE",
"sso-url": "<string>",
"token-endpoint": "<string>",
"userinfo-endpoint": "<string>",
"username-attribute": "<string>",
"username-claim": "<string>"
}Returns a list of all the users created by JIT (Just-in-time) provisioning.
Just-in-time user provisioning (JIT provisioning) allows users to be created and updated automatically when they log in through SAML SSO or OpenID Connect (OIDC) SSO.
This request has no parameters.
A list of JIT users
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/authconfig/latest/jit-users' \
--header 'Accept: application/json'1
2
3
4
5
{
"display-name": "<string>",
"email": "<string>",
"username": "<string>"
}Returns a list of available login options, which contains details about the metadata required for the login page. Only enabled login options will be returned. Login options can either be the native login form or the configured IdPs.
number
number
A list of login options
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/authconfig/latest/login-options' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"isLastPage": true,
"limit": 25,
"results": [
{
"buttonText": "<string>",
"id": 2154,
"loginLink": "<string>",
"type": "LOGIN_FORM"
}
],
"size": 1,
"start": 2154
}Returns the SSO configuration.
This request has no parameters.
The SSO configuration
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/authconfig/latest/sso' \
--header 'Accept: application/json'1
2
3
4
5
6
7
{
"discovery-refresh-cron": "<string>",
"enable-authentication-fallback": true,
"last-updated": "<string>",
"show-login-form": true,
"show-login-form-for-jsm": true
}Update the SSO configuration.
A request containing the SSO configuration to update.
string
boolean
string
boolean
boolean
The updated SSO Configuration
1
2
3
4
5
6
7
8
9
10
11
curl --request PATCH \
--url 'http://{baseurl}/rest/authconfig/latest/sso' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"discovery-refresh-cron": "<string>",
"enable-authentication-fallback": true,
"last-updated": "<string>",
"show-login-form": true,
"show-login-form-for-jsm": true
}'1
2
3
4
5
6
7
{
"discovery-refresh-cron": "<string>",
"enable-authentication-fallback": true,
"last-updated": "<string>",
"show-login-form": true,
"show-login-form-for-jsm": true
}Get the current configuration for blocking basic authentication requests.
This request has no parameters.
The blocking basic authentication configuration.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/basicauth/latest/config' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"allowed-paths": [
"<string>"
],
"allowed-users": [
"<string>"
],
"block-requests": true,
"show-warning-message": true
}Store a new configuration for blocking basic authentication requests.
A request containing the new basic authentication configuration.
array<string>
array<string>
boolean
boolean
The basic authentication blocking configuration was successfully created or updated.
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'http://{baseurl}/rest/basicauth/latest/config' \
--header 'Content-Type: application/json' \
--data '{
"allowed-paths": [
"<string>"
],
"allowed-users": [
"<string>"
],
"block-requests": true,
"show-warning-message": true
}'Authenticates as the given user. This endpoint may:
string
string
string
boolean
string
string
The user has successfully authenticated.
1
2
3
4
5
6
7
8
9
10
11
12
curl --request POST \
--url 'http://{baseurl}/rest/tsv/latest/authenticate' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"captchaChallenge": "<string>",
"captchaId": "<string>",
"password": "<string>",
"rememberMe": true,
"targetUrl": "<string>",
"username": "<string>"
}'1
2
3
{
"next": "<string>"
}Provides data for a CAPTCHA challenge.
This request has no parameters.
The CAPTCHA challenge
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/tsv/latest/authenticate/captcha' \
--header 'Accept: application/json'1
2
3
4
{
"captchaId": "<string>",
"captchaImageUrl": "<string>"
}Authenticate as the given user using a recovery code.
A request containing a recovery code for the specified user.
string
string
The user was successfully logged in.
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/tsv/latest/authenticate/recovery-code' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"conversationId": "<string>",
"recoveryCode": "<string>"
}'1
2
3
{
"next": "<string>"
}Authenticate as the given user using a TOTP code.
A request containing a TOTP code for the given user.
string
string
The user was successfully logged in.
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/tsv/latest/authenticate/totp-code' \
--header 'Content-Type: application/json' \
--data '{
"conversationId": "<string>",
"totpCode": "<string>"
}'Checks the state of an elevated session for the currently authenticated user.
string
An elevated session exists for the currently authenticated user.
1
2
curl --request GET \
--url 'http://{baseurl}/rest/tsv/latest/elevate-permissions'Elevate permissions by providing the password for the currently authenticated user. This will create an elevated session.
string
A request containing the password for the currently authenticated user.
string
Permissions were successfully elevated.
1
2
3
4
5
6
curl --request POST \
--url 'http://{baseurl}/rest/tsv/latest/elevate-permissions/password' \
--header 'Content-Type: application/json' \
--data '{
"totpCode": "<string>"
}'Elevate permissions by providing a recovery code for the currently authenticated user. This will create an elevated session.
string
A request containing a recovery code for the currently authenticated user.
string
Permissions were successfully elevated.
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/tsv/latest/elevate-permissions/recovery-code' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"recoveryCode": "<string>"
}'1
2
3
{
"recoveryCode": "<string>"
}Elevate permissions by providing a TOTP code for the currently authenticated user. This will create an elevated session.
string
A request containing a TOTP code for the given user.
string
Permissions were successfully elevated.
1
2
3
4
5
6
curl --request POST \
--url 'http://{baseurl}/rest/tsv/latest/elevate-permissions/totp' \
--header 'Content-Type: application/json' \
--data '{
"totpCode": "<string>"
}'Retrieves the status of the SSO management for the currently authenticated user.
This request has no parameters.
Successfully retrieved SSO management status
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/tsv/latest/sso-management-status' \
--header 'Accept: application/json'1
2
3
{
"isManaged": true
}Retrieves the status of two-step verification for the currently authenticated user.
This request has no parameters.
Successfully retrieved the two-step verification status.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/tsv/latest/status' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"methods": [
{
"enabled": true,
"enabledAt": "<string>",
"type": "TOTP"
}
],
"twoSVActive": true
}Complete enforced enrollment in two-step verification by verifying the provided TOTP code and creating a new session for the given user.
A request containing a TOTP code for the given user.
string
string
Enrollment successfully completed.
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/tsv/latest/totp/complete-enforced-enrollment' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"conversationId": "<string>",
"totpCode": "<string>"
}'1
2
3
{
"recoveryCode": "<string>"
}Complete update of the authentication app used for two-step verification by verifying the provided TOTP code.
A request containing a TOTP code for the given user.
string
string
Authentication app successfully updated.
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/tsv/latest/totp/complete-enrollment-update' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"conversationId": "<string>",
"totpCode": "<string>"
}'1
2
3
4
5
6
{
"conversationId": "<string>",
"secret": "<string>",
"url": "<string>",
"userName": "<string>"
}Complete voluntary enrollment in two-step verification by verifying the provided TOTP code and creating a new session for the given user.
A request containing a TOTP code for the given user.
string
string
Enrollment successfully completed.
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/tsv/latest/totp/complete-voluntary-enrollment' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"conversationId": "<string>",
"totpCode": "<string>"
}'1
2
3
4
5
6
{
"conversationId": "<string>",
"secret": "<string>",
"url": "<string>",
"userName": "<string>"
}Rotates the recovery code for the currently authentication user.
This request has no parameters.
The recovery code has been successfully rotated.
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/tsv/latest/totp/recovery-code/rotate' \
--header 'Accept: application/json'1
2
3
{
"recoveryCode": "<string>"
}Start or resume enforced enrollment in two-step verification by returning the conversation details.
There are two ways to enroll in two-step verification: voluntary and enforced. Enrollment is a two-step process. First, the user starts the enrollment process via /start-voluntary-enrollment or /start-enforced-enrollment. Second and final step is to complete the enrollment via /complete-voluntary-enrollment or /complete-enforced-enrollment. In the case of enforced enrollment, the conversation is started at the time of login via /authenticate.
string
A conversation has successfully started.
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/tsv/latest/totp/start-enforced-enrollment' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"conversationId": "<string>"
}'1
2
3
4
5
6
{
"conversationId": "<string>",
"secret": "<string>",
"url": "<string>",
"userName": "<string>"
}Start the process of changing the authentication app used for two-step verification by creating a conversation.
This request has no parameters.
A conversation has successfully started.
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/tsv/latest/totp/start-enrollment-update' \
--header 'Accept: application/json'1
2
3
4
5
6
{
"conversationId": "<string>",
"secret": "<string>",
"url": "<string>",
"userName": "<string>"
}Start voluntary enrollment in two-step verification by creating a conversation.
There are two ways to enroll in two-step verification: voluntary and enforced. Enrollment is a two-step process. First, the user starts the enrollment process via /start-voluntary-enrollment or /start-enforced-enrollment. Second and final step is to complete the enrollment via /complete-voluntary-enrollment or /complete-enforced-enrollment. In the case of enforced enrollment, the conversation is started at the time of login via /authenticate.
This request has no parameters.
A conversation has successfully started.
1
2
3
curl --request POST \
--url 'http://{baseurl}/rest/tsv/latest/totp/start-voluntary-enrollment' \
--header 'Accept: application/json'1
2
3
4
5
6
{
"conversationId": "<string>",
"secret": "<string>",
"url": "<string>",
"userName": "<string>"
}Unenroll the currently authenticated user from two-step verification.
This request has no parameters.
User successfully unenrolled from two-step verification.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/tsv/latest/totp/unenroll'Unenroll a user from two-step verification specified by the given username.
string
RequiredA request containing a TOTP code for the given user.
string
User successfully unenrolled from two-step verification.
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/tsv/latest/totp/unenroll/user/{userName}' \
--header 'Content-Type: application/json' \
--data '{
"totpCode": "<string>"
}'Rate this page: