AuthAPI

All URIs are relative to https://elements.local

Method	HTTP request	Description
checkAuthTicket	POST /api/2/auth/ticket/check
createAPIToken	POST /api/2/api-tokens
createAuthTicket	POST /api/2/auth/ticket
createSAMLProvider	POST /api/2/auth/saml
deleteAPIToken	DELETE /api/2/api-tokens/{id}
deleteAccessToken	DELETE /api/2/auth/access-tokens/{id}
deleteSAMLProvider	DELETE /api/2/auth/saml/{id}
generatePassword	POST /api/2/auth/generate-password
getAPIToken	GET /api/2/api-tokens/{id}
getAccessToken	GET /api/2/auth/access-tokens/{id}
getAllAPITokens	GET /api/2/api-tokens
getAllAccessTokens	GET /api/2/auth/access-tokens
getAllSAMLProviders	GET /api/2/auth/saml
getSAMLProvider	GET /api/2/auth/saml/{id}
getSAMLServiceProviderMetadata	GET /api/2/auth/saml/{id}/metadata
login	POST /api/2/auth/login
logout	POST /api/2/auth/logout
logoutPage	GET /api/2/auth/logout
parseSAMLIDPMetadata	POST /api/2/auth/saml/parse-idp-metadata
patchAPIToken	PATCH /api/2/api-tokens/{id}
patchSAMLProvider	PATCH /api/2/auth/saml/{id}
receiveSAMLAuthAssertion	POST /api/2/auth/saml/{id}/assertion
refreshSAMLIDPMetadata	POST /api/2/auth/saml/{id}/refresh-idp-metadata
resetPassword	POST /api/2/auth/reset-password
returnFromSAMLAuth	GET /api/2/auth/saml/{id}/sso/return
returnFromSAMLLogout	GET /api/2/auth/saml/{id}/sls/return
sendAccessTokenEmailNotification	POST /api/2/auth/access-tokens/{id}/email
startImpersonation	POST /api/2/auth/impersonation
startSAMLAuth	GET /api/2/auth/saml/{id}/sso
startSAMLLogout	GET /api/2/auth/saml/{id}/sls
stopImpersonation	POST /api/2/auth/impersonation/stop
updateAPIToken	PUT /api/2/api-tokens/{id}
updateSAMLProvider	PUT /api/2/auth/saml/{id}

checkAuthTicket

    open class func checkAuthTicket( ticket: Ticket) -> Promise<ElementsUserDetail>

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ticket = Ticket(ticket: "ticket_example") // Ticket | 

AuthAPI.checkAuthTicket(ticket: ticket).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
ticket	Ticket

Return type

ElementsUserDetail

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createAPIToken

    open class func createAPIToken( aPITokenWithSecretUpdate: APITokenWithSecretUpdate) -> Promise<APITokenWithSecret>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let aPITokenWithSecretUpdate = APITokenWithSecretUpdate(token: "token_example", name: "name_example") // APITokenWithSecretUpdate | 

AuthAPI.createAPIToken(aPITokenWithSecretUpdate: aPITokenWithSecretUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
aPITokenWithSecretUpdate	APITokenWithSecretUpdate

Return type

APITokenWithSecret

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createAuthTicket

    open class func createAuthTicket() -> Promise<Ticket>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


AuthAPI.createAuthTicket().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Ticket

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createSAMLProvider

    open class func createSAMLProvider( sAMLProviderUpdate: SAMLProviderUpdate) -> Promise<SAMLProvider>

Required permissions * User account permission: `None` (read) / `system:admin-access` (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let sAMLProviderUpdate = SAMLProviderUpdate(name: "name_example", entityId: "entityId_example", ssoUrl: "ssoUrl_example", sloUrl: "sloUrl_example", certificate: "certificate_example", spCertificate: "spCertificate_example", spCertificateKey: "spCertificateKey_example") // SAMLProviderUpdate | 

AuthAPI.createSAMLProvider(sAMLProviderUpdate: sAMLProviderUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
sAMLProviderUpdate	SAMLProviderUpdate

Return type

SAMLProvider

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAPIToken

    open class func deleteAPIToken( id: Int) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this api token.

AuthAPI.deleteAPIToken(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this api token.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAccessToken

    open class func deleteAccessToken( id: Int) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this one time access token.

AuthAPI.deleteAccessToken(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this one time access token.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteSAMLProvider

    open class func deleteSAMLProvider( id: Int) -> Promise<Void>

Required permissions * User account permission: `None` (read) / `system:admin-access` (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this SAML Provider.

AuthAPI.deleteSAMLProvider(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generatePassword

    open class func generatePassword() -> Promise<GeneratePasswordEndpointResponse>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


AuthAPI.generatePassword().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

GeneratePasswordEndpointResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAPIToken

    open class func getAPIToken( id: Int) -> Promise<APIToken>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this api token.

AuthAPI.getAPIToken(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this api token.

Return type

APIToken

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAccessToken

    open class func getAccessToken( id: Int) -> Promise<OneTimeAccessToken>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this one time access token.

AuthAPI.getAccessToken(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this one time access token.

Return type

OneTimeAccessToken

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllAPITokens

    open class func getAllAPITokens( name: String? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[APIToken]>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let name = "name_example" // String | Filter the returned list by `name`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

AuthAPI.getAllAPITokens(name: name, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
name	String	Filter the returned list by `name`.	[optional]
ordering	String	Which field to use when ordering the results.	[optional]
limit	Int	Number of results to return per page.	[optional]
offset	Int	The initial index from which to return the results.	[optional]

Return type

[APIToken]

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllAccessTokens

    open class func getAllAccessTokens( sharedBundles: String? = nil,  sharedDirectories: String? = nil,  sharedBundlesAsset: Double? = nil,  user: Double? = nil,  createdBy: Double? = nil,  ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[OneTimeAccessToken]>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let sharedBundles = "sharedBundles_example" // String | Filter the returned list by `shared_bundles`. (optional)
let sharedDirectories = "sharedDirectories_example" // String | Filter the returned list by `shared_directories`. (optional)
let sharedBundlesAsset = 987 // Double | Filter the returned list by `shared_bundles__asset`. (optional)
let user = 987 // Double | Filter the returned list by `user`. (optional)
let createdBy = 987 // Double | Filter the returned list by `created_by`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

AuthAPI.getAllAccessTokens(sharedBundles: sharedBundles, sharedDirectories: sharedDirectories, sharedBundlesAsset: sharedBundlesAsset, user: user, createdBy: createdBy, ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
sharedBundles	String	Filter the returned list by `shared_bundles`.	[optional]
sharedDirectories	String	Filter the returned list by `shared_directories`.	[optional]
sharedBundlesAsset	Double	Filter the returned list by `shared_bundles__asset`.	[optional]
user	Double	Filter the returned list by `user`.	[optional]
createdBy	Double	Filter the returned list by `created_by`.	[optional]
ordering	String	Which field to use when ordering the results.	[optional]
limit	Int	Number of results to return per page.	[optional]
offset	Int	The initial index from which to return the results.	[optional]

Return type

[OneTimeAccessToken]

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAllSAMLProviders

    open class func getAllSAMLProviders( ordering: String? = nil,  limit: Int? = nil,  offset: Int? = nil) -> Promise<[SAMLProvider]>

Required permissions * User account permission: `None` (read) / `system:admin-access` (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)

AuthAPI.getAllSAMLProviders(ordering: ordering, limit: limit, offset: offset).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
ordering	String	Which field to use when ordering the results.	[optional]
limit	Int	Number of results to return per page.	[optional]
offset	Int	The initial index from which to return the results.	[optional]

Return type

[SAMLProvider]

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSAMLProvider

    open class func getSAMLProvider( id: Int) -> Promise<SAMLProvider>

Required permissions * User account permission: `None` (read) / `system:admin-access` (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this SAML Provider.

AuthAPI.getSAMLProvider(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.

Return type

SAMLProvider

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSAMLServiceProviderMetadata

    open class func getSAMLServiceProviderMetadata( id: Int) -> Promise<Void>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this SAML Provider.

AuthAPI.getSAMLServiceProviderMetadata(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

login

    open class func login( authLoginEndpointRequest: AuthLoginEndpointRequest) -> Promise<AuthLoginEndpointResponse>

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let authLoginEndpointRequest = AuthLoginEndpointRequest(username: "username_example", password: "password_example", otp: "otp_example", newPassword: "newPassword_example") // AuthLoginEndpointRequest | 

AuthAPI.login(authLoginEndpointRequest: authLoginEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
authLoginEndpointRequest	AuthLoginEndpointRequest

Return type

AuthLoginEndpointResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

logout

    open class func logout() -> Promise<Void>

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


AuthAPI.logout().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

logoutPage

    open class func logoutPage() -> Promise<Void>

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


AuthAPI.logoutPage().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

parseSAMLIDPMetadata

    open class func parseSAMLIDPMetadata( parseSAMLIDPMetadataRequest: ParseSAMLIDPMetadataRequest) -> Promise<ParsedSAMLIDPMetadata>

Required permissions * User account permission: `system:admin-access`

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let parseSAMLIDPMetadataRequest = ParseSAMLIDPMetadataRequest(url: "url_example") // ParseSAMLIDPMetadataRequest | 

AuthAPI.parseSAMLIDPMetadata(parseSAMLIDPMetadataRequest: parseSAMLIDPMetadataRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
parseSAMLIDPMetadataRequest	ParseSAMLIDPMetadataRequest

Return type

ParsedSAMLIDPMetadata

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchAPIToken

    open class func patchAPIToken( id: Int,  aPITokenPartialUpdate: APITokenPartialUpdate) -> Promise<APIToken>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this api token.
let aPITokenPartialUpdate = APITokenPartialUpdate(name: "name_example") // APITokenPartialUpdate | 

AuthAPI.patchAPIToken(id: id, aPITokenPartialUpdate: aPITokenPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this api token.
aPITokenPartialUpdate	APITokenPartialUpdate

Return type

APIToken

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchSAMLProvider

    open class func patchSAMLProvider( id: Int,  sAMLProviderPartialUpdate: SAMLProviderPartialUpdate) -> Promise<SAMLProvider>

Required permissions * User account permission: `None` (read) / `system:admin-access` (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this SAML Provider.
let sAMLProviderPartialUpdate = SAMLProviderPartialUpdate(name: "name_example", entityId: "entityId_example", ssoUrl: "ssoUrl_example", sloUrl: "sloUrl_example", certificate: "certificate_example", spCertificate: "spCertificate_example", spCertificateKey: "spCertificateKey_example") // SAMLProviderPartialUpdate | 

AuthAPI.patchSAMLProvider(id: id, sAMLProviderPartialUpdate: sAMLProviderPartialUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.
sAMLProviderPartialUpdate	SAMLProviderPartialUpdate

Return type

SAMLProvider

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

receiveSAMLAuthAssertion

    open class func receiveSAMLAuthAssertion( id: Int) -> Promise<Void>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this SAML Provider.

AuthAPI.receiveSAMLAuthAssertion(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

refreshSAMLIDPMetadata

    open class func refreshSAMLIDPMetadata( id: Int,  parseSAMLIDPMetadataRequest: ParseSAMLIDPMetadataRequest) -> Promise<ParsedSAMLIDPMetadata>

Required permissions * User account permission: `system:admin-access`

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this SAML Provider.
let parseSAMLIDPMetadataRequest = ParseSAMLIDPMetadataRequest(url: "url_example") // ParseSAMLIDPMetadataRequest | 

AuthAPI.refreshSAMLIDPMetadata(id: id, parseSAMLIDPMetadataRequest: parseSAMLIDPMetadataRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.
parseSAMLIDPMetadataRequest	ParseSAMLIDPMetadataRequest

Return type

ParsedSAMLIDPMetadata

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resetPassword

    open class func resetPassword( passwordResetEndpointRequest: PasswordResetEndpointRequest) -> Promise<Void>

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let passwordResetEndpointRequest = PasswordResetEndpointRequest(token: "token_example", password: "password_example") // PasswordResetEndpointRequest | 

AuthAPI.resetPassword(passwordResetEndpointRequest: passwordResetEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
passwordResetEndpointRequest	PasswordResetEndpointRequest

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

returnFromSAMLAuth

    open class func returnFromSAMLAuth( id: Int) -> Promise<Void>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this SAML Provider.

AuthAPI.returnFromSAMLAuth(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

returnFromSAMLLogout

    open class func returnFromSAMLLogout( id: Int) -> Promise<Void>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this SAML Provider.

AuthAPI.returnFromSAMLLogout(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sendAccessTokenEmailNotification

    open class func sendAccessTokenEmailNotification( id: Int,  sendLinkEmailRequest: SendLinkEmailRequest) -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this one time access token.
let sendLinkEmailRequest = SendLinkEmailRequest(email: "email_example", subject: "subject_example", text: "text_example") // SendLinkEmailRequest | 

AuthAPI.sendAccessTokenEmailNotification(id: id, sendLinkEmailRequest: sendLinkEmailRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this one time access token.
sendLinkEmailRequest	SendLinkEmailRequest

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

startImpersonation

    open class func startImpersonation( impersonationEndpointRequest: ImpersonationEndpointRequest) -> Promise<Void>

Required permissions * User account permission: `system:admin-access`

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let impersonationEndpointRequest = ImpersonationEndpointRequest(user: 123) // ImpersonationEndpointRequest | 

AuthAPI.startImpersonation(impersonationEndpointRequest: impersonationEndpointRequest).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
impersonationEndpointRequest	ImpersonationEndpointRequest

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

startSAMLAuth

    open class func startSAMLAuth( id: Int) -> Promise<Void>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this SAML Provider.

AuthAPI.startSAMLAuth(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

startSAMLLogout

    open class func startSAMLLogout( id: Int) -> Promise<Void>

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this SAML Provider.

AuthAPI.startSAMLLogout(id: id).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

stopImpersonation

    open class func stopImpersonation() -> Promise<Void>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK


AuthAPI.stopImpersonation().then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateAPIToken

    open class func updateAPIToken( id: Int,  aPITokenUpdate: APITokenUpdate) -> Promise<APIToken>

Required permissions * Authenticated user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this api token.
let aPITokenUpdate = APITokenUpdate(name: "name_example") // APITokenUpdate | 

AuthAPI.updateAPIToken(id: id, aPITokenUpdate: aPITokenUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this api token.
aPITokenUpdate	APITokenUpdate

Return type

APIToken

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateSAMLProvider

    open class func updateSAMLProvider( id: Int,  sAMLProviderUpdate: SAMLProviderUpdate) -> Promise<SAMLProvider>

Required permissions * User account permission: `None` (read) / `system:admin-access` (write)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK

let id = 987 // Int | A unique integer value identifying this SAML Provider.
let sAMLProviderUpdate = SAMLProviderUpdate(name: "name_example", entityId: "entityId_example", ssoUrl: "ssoUrl_example", sloUrl: "sloUrl_example", certificate: "certificate_example", spCertificate: "spCertificate_example", spCertificateKey: "spCertificateKey_example") // SAMLProviderUpdate | 

AuthAPI.updateSAMLProvider(id: id, sAMLProviderUpdate: sAMLProviderUpdate).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.
sAMLProviderUpdate	SAMLProviderUpdate

Return type

SAMLProvider

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

AuthAPI.md

Latest commit

History

AuthAPI.md

File metadata and controls

AuthAPI

checkAuthTicket

Required permissions * <class 'rest_framework.permissions.AllowAny'>

Example

Parameters

Return type

Authorization

HTTP request headers

createAPIToken

Required permissions * Authenticated user

Example

Parameters

Return type

Authorization

HTTP request headers

createAuthTicket

Required permissions * Authenticated user

Example

Parameters

Return type

Authorization

HTTP request headers

createSAMLProvider

Required permissions * User account permission: None (read) / system:admin-access (write)

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAPIToken

Required permissions * Authenticated user

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAccessToken

Required permissions * Authenticated user

Example

Parameters

Return type

Authorization

HTTP request headers

deleteSAMLProvider

Required permissions * User account permission: None (read) / system:admin-access (write)

Example

Parameters

Return type

Authorization

HTTP request headers

generatePassword

Required permissions * Authenticated user

Example

Parameters

Return type

Authorization

HTTP request headers

getAPIToken

Required permissions * Authenticated user

Example

Parameters

Return type

Authorization

HTTP request headers

getAccessToken

Required permissions * Authenticated user

Example

Parameters

Return type

Authorization

HTTP request headers

getAllAPITokens

Required permissions * Authenticated user

Example

Required permissions * User account permission: `None` (read) / `system:admin-access` (write)

Required permissions * User account permission: `None` (read) / `system:admin-access` (write)

Required permissions * User account permission: `None` (read) / `system:admin-access` (write)

Required permissions * User account permission: `None` (read) / `system:admin-access` (write)

Required permissions * User account permission: `system:admin-access`