SamlApi
SamlApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- createOrganizationSamlIdp() : object
- Operation createOrganizationSamlIdp
- createOrganizationSamlIdpAsync() : PromiseInterface
- Operation createOrganizationSamlIdpAsync
- createOrganizationSamlIdpAsyncWithHttpInfo() : PromiseInterface
- Operation createOrganizationSamlIdpAsyncWithHttpInfo
- createOrganizationSamlIdpWithHttpInfo() : array<string|int, mixed>
- Operation createOrganizationSamlIdpWithHttpInfo
- deleteOrganizationSamlIdp() : void
- Operation deleteOrganizationSamlIdp
- deleteOrganizationSamlIdpAsync() : PromiseInterface
- Operation deleteOrganizationSamlIdpAsync
- deleteOrganizationSamlIdpAsyncWithHttpInfo() : PromiseInterface
- Operation deleteOrganizationSamlIdpAsyncWithHttpInfo
- deleteOrganizationSamlIdpWithHttpInfo() : array<string|int, mixed>
- Operation deleteOrganizationSamlIdpWithHttpInfo
- getConfig() : Configuration
- getOrganizationSaml() : object
- Operation getOrganizationSaml
- getOrganizationSamlAsync() : PromiseInterface
- Operation getOrganizationSamlAsync
- getOrganizationSamlAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationSamlAsyncWithHttpInfo
- getOrganizationSamlIdp() : object
- Operation getOrganizationSamlIdp
- getOrganizationSamlIdpAsync() : PromiseInterface
- Operation getOrganizationSamlIdpAsync
- getOrganizationSamlIdpAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationSamlIdpAsyncWithHttpInfo
- getOrganizationSamlIdps() : object
- Operation getOrganizationSamlIdps
- getOrganizationSamlIdpsAsync() : PromiseInterface
- Operation getOrganizationSamlIdpsAsync
- getOrganizationSamlIdpsAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationSamlIdpsAsyncWithHttpInfo
- getOrganizationSamlIdpsWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationSamlIdpsWithHttpInfo
- getOrganizationSamlIdpWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationSamlIdpWithHttpInfo
- getOrganizationSamlWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationSamlWithHttpInfo
- updateOrganizationSaml() : object
- Operation updateOrganizationSaml
- updateOrganizationSamlAsync() : PromiseInterface
- Operation updateOrganizationSamlAsync
- updateOrganizationSamlAsyncWithHttpInfo() : PromiseInterface
- Operation updateOrganizationSamlAsyncWithHttpInfo
- updateOrganizationSamlIdp() : object
- Operation updateOrganizationSamlIdp
- updateOrganizationSamlIdpAsync() : PromiseInterface
- Operation updateOrganizationSamlIdpAsync
- updateOrganizationSamlIdpAsyncWithHttpInfo() : PromiseInterface
- Operation updateOrganizationSamlIdpAsyncWithHttpInfo
- updateOrganizationSamlIdpWithHttpInfo() : array<string|int, mixed>
- Operation updateOrganizationSamlIdpWithHttpInfo
- updateOrganizationSamlWithHttpInfo() : array<string|int, mixed>
- Operation updateOrganizationSamlWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- createOrganizationSamlIdpRequest() : Request
- Create request for operation 'createOrganizationSamlIdp'
- deleteOrganizationSamlIdpRequest() : Request
- Create request for operation 'deleteOrganizationSamlIdp'
- getOrganizationSamlIdpRequest() : Request
- Create request for operation 'getOrganizationSamlIdp'
- getOrganizationSamlIdpsRequest() : Request
- Create request for operation 'getOrganizationSamlIdps'
- getOrganizationSamlRequest() : Request
- Create request for operation 'getOrganizationSaml'
- updateOrganizationSamlIdpRequest() : Request
- Create request for operation 'updateOrganizationSamlIdp'
- updateOrganizationSamlRequest() : Request
- Create request for operation 'updateOrganizationSaml'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —createOrganizationSamlIdp()
Operation createOrganizationSamlIdp
public
createOrganizationSamlIdp(string $organization_id, CreateOrganizationSamlIdp $create_organization_saml_idp) : object
Create a SAML IdP for your organization.
Parameters
- $organization_id : string
-
organization_id (required)
- $create_organization_saml_idp : CreateOrganizationSamlIdp
-
create_organization_saml_idp (required)
Tags
Return values
object —createOrganizationSamlIdpAsync()
Operation createOrganizationSamlIdpAsync
public
createOrganizationSamlIdpAsync(string $organization_id, CreateOrganizationSamlIdp $create_organization_saml_idp) : PromiseInterface
Create a SAML IdP for your organization.
Parameters
- $organization_id : string
-
(required)
- $create_organization_saml_idp : CreateOrganizationSamlIdp
-
(required)
Tags
Return values
PromiseInterface —createOrganizationSamlIdpAsyncWithHttpInfo()
Operation createOrganizationSamlIdpAsyncWithHttpInfo
public
createOrganizationSamlIdpAsyncWithHttpInfo(string $organization_id, CreateOrganizationSamlIdp $create_organization_saml_idp) : PromiseInterface
Create a SAML IdP for your organization.
Parameters
- $organization_id : string
-
(required)
- $create_organization_saml_idp : CreateOrganizationSamlIdp
-
(required)
Tags
Return values
PromiseInterface —createOrganizationSamlIdpWithHttpInfo()
Operation createOrganizationSamlIdpWithHttpInfo
public
createOrganizationSamlIdpWithHttpInfo(string $organization_id, CreateOrganizationSamlIdp $create_organization_saml_idp) : array<string|int, mixed>
Create a SAML IdP for your organization.
Parameters
- $organization_id : string
-
(required)
- $create_organization_saml_idp : CreateOrganizationSamlIdp
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
deleteOrganizationSamlIdp()
Operation deleteOrganizationSamlIdp
public
deleteOrganizationSamlIdp(string $organization_id, string $idp_id) : void
Remove a SAML IdP in your organization.
Parameters
- $organization_id : string
-
organization_id (required)
- $idp_id : string
-
idp_id (required)
Tags
Return values
void —deleteOrganizationSamlIdpAsync()
Operation deleteOrganizationSamlIdpAsync
public
deleteOrganizationSamlIdpAsync(string $organization_id, string $idp_id) : PromiseInterface
Remove a SAML IdP in your organization.
Parameters
- $organization_id : string
-
(required)
- $idp_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteOrganizationSamlIdpAsyncWithHttpInfo()
Operation deleteOrganizationSamlIdpAsyncWithHttpInfo
public
deleteOrganizationSamlIdpAsyncWithHttpInfo(string $organization_id, string $idp_id) : PromiseInterface
Remove a SAML IdP in your organization.
Parameters
- $organization_id : string
-
(required)
- $idp_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteOrganizationSamlIdpWithHttpInfo()
Operation deleteOrganizationSamlIdpWithHttpInfo
public
deleteOrganizationSamlIdpWithHttpInfo(string $organization_id, string $idp_id) : array<string|int, mixed>
Remove a SAML IdP in your organization.
Parameters
- $organization_id : string
-
(required)
- $idp_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getOrganizationSaml()
Operation getOrganizationSaml
public
getOrganizationSaml(string $organization_id) : object
Returns the SAML SSO enabled settings for an organization.
Parameters
- $organization_id : string
-
organization_id (required)
Tags
Return values
object —getOrganizationSamlAsync()
Operation getOrganizationSamlAsync
public
getOrganizationSamlAsync(string $organization_id) : PromiseInterface
Returns the SAML SSO enabled settings for an organization.
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationSamlAsyncWithHttpInfo()
Operation getOrganizationSamlAsyncWithHttpInfo
public
getOrganizationSamlAsyncWithHttpInfo(string $organization_id) : PromiseInterface
Returns the SAML SSO enabled settings for an organization.
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationSamlIdp()
Operation getOrganizationSamlIdp
public
getOrganizationSamlIdp(string $organization_id, string $idp_id) : object
Get a SAML IdP from your organization.
Parameters
- $organization_id : string
-
organization_id (required)
- $idp_id : string
-
idp_id (required)
Tags
Return values
object —getOrganizationSamlIdpAsync()
Operation getOrganizationSamlIdpAsync
public
getOrganizationSamlIdpAsync(string $organization_id, string $idp_id) : PromiseInterface
Get a SAML IdP from your organization.
Parameters
- $organization_id : string
-
(required)
- $idp_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationSamlIdpAsyncWithHttpInfo()
Operation getOrganizationSamlIdpAsyncWithHttpInfo
public
getOrganizationSamlIdpAsyncWithHttpInfo(string $organization_id, string $idp_id) : PromiseInterface
Get a SAML IdP from your organization.
Parameters
- $organization_id : string
-
(required)
- $idp_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationSamlIdps()
Operation getOrganizationSamlIdps
public
getOrganizationSamlIdps(string $organization_id) : object
List the SAML IdPs in your organization.
Parameters
- $organization_id : string
-
organization_id (required)
Tags
Return values
object —getOrganizationSamlIdpsAsync()
Operation getOrganizationSamlIdpsAsync
public
getOrganizationSamlIdpsAsync(string $organization_id) : PromiseInterface
List the SAML IdPs in your organization.
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationSamlIdpsAsyncWithHttpInfo()
Operation getOrganizationSamlIdpsAsyncWithHttpInfo
public
getOrganizationSamlIdpsAsyncWithHttpInfo(string $organization_id) : PromiseInterface
List the SAML IdPs in your organization.
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationSamlIdpsWithHttpInfo()
Operation getOrganizationSamlIdpsWithHttpInfo
public
getOrganizationSamlIdpsWithHttpInfo(string $organization_id) : array<string|int, mixed>
List the SAML IdPs in your organization.
Parameters
- $organization_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationSamlIdpWithHttpInfo()
Operation getOrganizationSamlIdpWithHttpInfo
public
getOrganizationSamlIdpWithHttpInfo(string $organization_id, string $idp_id) : array<string|int, mixed>
Get a SAML IdP from your organization.
Parameters
- $organization_id : string
-
(required)
- $idp_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationSamlWithHttpInfo()
Operation getOrganizationSamlWithHttpInfo
public
getOrganizationSamlWithHttpInfo(string $organization_id) : array<string|int, mixed>
Returns the SAML SSO enabled settings for an organization.
Parameters
- $organization_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateOrganizationSaml()
Operation updateOrganizationSaml
public
updateOrganizationSaml(string $organization_id[, UpdateOrganizationSaml $update_organization_saml = null ]) : object
Updates the SAML SSO enabled settings for an organization.
Parameters
- $organization_id : string
-
organization_id (required)
- $update_organization_saml : UpdateOrganizationSaml = null
-
update_organization_saml (optional)
Tags
Return values
object —updateOrganizationSamlAsync()
Operation updateOrganizationSamlAsync
public
updateOrganizationSamlAsync(string $organization_id[, UpdateOrganizationSaml $update_organization_saml = null ]) : PromiseInterface
Updates the SAML SSO enabled settings for an organization.
Parameters
- $organization_id : string
-
(required)
- $update_organization_saml : UpdateOrganizationSaml = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationSamlAsyncWithHttpInfo()
Operation updateOrganizationSamlAsyncWithHttpInfo
public
updateOrganizationSamlAsyncWithHttpInfo(string $organization_id[, UpdateOrganizationSaml $update_organization_saml = null ]) : PromiseInterface
Updates the SAML SSO enabled settings for an organization.
Parameters
- $organization_id : string
-
(required)
- $update_organization_saml : UpdateOrganizationSaml = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationSamlIdp()
Operation updateOrganizationSamlIdp
public
updateOrganizationSamlIdp(string $organization_id, string $idp_id[, UpdateOrganizationSamlIdp $update_organization_saml_idp = null ]) : object
Update a SAML IdP in your organization
Parameters
- $organization_id : string
-
organization_id (required)
- $idp_id : string
-
idp_id (required)
- $update_organization_saml_idp : UpdateOrganizationSamlIdp = null
-
update_organization_saml_idp (optional)
Tags
Return values
object —updateOrganizationSamlIdpAsync()
Operation updateOrganizationSamlIdpAsync
public
updateOrganizationSamlIdpAsync(string $organization_id, string $idp_id[, UpdateOrganizationSamlIdp $update_organization_saml_idp = null ]) : PromiseInterface
Update a SAML IdP in your organization
Parameters
- $organization_id : string
-
(required)
- $idp_id : string
-
(required)
- $update_organization_saml_idp : UpdateOrganizationSamlIdp = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationSamlIdpAsyncWithHttpInfo()
Operation updateOrganizationSamlIdpAsyncWithHttpInfo
public
updateOrganizationSamlIdpAsyncWithHttpInfo(string $organization_id, string $idp_id[, UpdateOrganizationSamlIdp $update_organization_saml_idp = null ]) : PromiseInterface
Update a SAML IdP in your organization
Parameters
- $organization_id : string
-
(required)
- $idp_id : string
-
(required)
- $update_organization_saml_idp : UpdateOrganizationSamlIdp = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationSamlIdpWithHttpInfo()
Operation updateOrganizationSamlIdpWithHttpInfo
public
updateOrganizationSamlIdpWithHttpInfo(string $organization_id, string $idp_id[, UpdateOrganizationSamlIdp $update_organization_saml_idp = null ]) : array<string|int, mixed>
Update a SAML IdP in your organization
Parameters
- $organization_id : string
-
(required)
- $idp_id : string
-
(required)
- $update_organization_saml_idp : UpdateOrganizationSamlIdp = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateOrganizationSamlWithHttpInfo()
Operation updateOrganizationSamlWithHttpInfo
public
updateOrganizationSamlWithHttpInfo(string $organization_id[, UpdateOrganizationSaml $update_organization_saml = null ]) : array<string|int, mixed>
Updates the SAML SSO enabled settings for an organization.
Parameters
- $organization_id : string
-
(required)
- $update_organization_saml : UpdateOrganizationSaml = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
createOrganizationSamlIdpRequest()
Create request for operation 'createOrganizationSamlIdp'
protected
createOrganizationSamlIdpRequest(string $organization_id, CreateOrganizationSamlIdp $create_organization_saml_idp) : Request
Parameters
- $organization_id : string
-
(required)
- $create_organization_saml_idp : CreateOrganizationSamlIdp
-
(required)
Tags
Return values
Request —deleteOrganizationSamlIdpRequest()
Create request for operation 'deleteOrganizationSamlIdp'
protected
deleteOrganizationSamlIdpRequest(string $organization_id, string $idp_id) : Request
Parameters
- $organization_id : string
-
(required)
- $idp_id : string
-
(required)
Tags
Return values
Request —getOrganizationSamlIdpRequest()
Create request for operation 'getOrganizationSamlIdp'
protected
getOrganizationSamlIdpRequest(string $organization_id, string $idp_id) : Request
Parameters
- $organization_id : string
-
(required)
- $idp_id : string
-
(required)
Tags
Return values
Request —getOrganizationSamlIdpsRequest()
Create request for operation 'getOrganizationSamlIdps'
protected
getOrganizationSamlIdpsRequest(string $organization_id) : Request
Parameters
- $organization_id : string
-
(required)
Tags
Return values
Request —getOrganizationSamlRequest()
Create request for operation 'getOrganizationSaml'
protected
getOrganizationSamlRequest(string $organization_id) : Request
Parameters
- $organization_id : string
-
(required)
Tags
Return values
Request —updateOrganizationSamlIdpRequest()
Create request for operation 'updateOrganizationSamlIdp'
protected
updateOrganizationSamlIdpRequest(string $organization_id, string $idp_id[, UpdateOrganizationSamlIdp $update_organization_saml_idp = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $idp_id : string
-
(required)
- $update_organization_saml_idp : UpdateOrganizationSamlIdp = null
-
(optional)
Tags
Return values
Request —updateOrganizationSamlRequest()
Create request for operation 'updateOrganizationSaml'
protected
updateOrganizationSamlRequest(string $organization_id[, UpdateOrganizationSaml $update_organization_saml = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $update_organization_saml : UpdateOrganizationSaml = null
-
(optional)