SamlRolesApi
SamlRolesApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- createOrganizationSamlRole() : object
- Operation createOrganizationSamlRole
- createOrganizationSamlRoleAsync() : PromiseInterface
- Operation createOrganizationSamlRoleAsync
- createOrganizationSamlRoleAsyncWithHttpInfo() : PromiseInterface
- Operation createOrganizationSamlRoleAsyncWithHttpInfo
- createOrganizationSamlRoleWithHttpInfo() : array<string|int, mixed>
- Operation createOrganizationSamlRoleWithHttpInfo
- deleteOrganizationSamlRole() : void
- Operation deleteOrganizationSamlRole
- deleteOrganizationSamlRoleAsync() : PromiseInterface
- Operation deleteOrganizationSamlRoleAsync
- deleteOrganizationSamlRoleAsyncWithHttpInfo() : PromiseInterface
- Operation deleteOrganizationSamlRoleAsyncWithHttpInfo
- deleteOrganizationSamlRoleWithHttpInfo() : array<string|int, mixed>
- Operation deleteOrganizationSamlRoleWithHttpInfo
- getConfig() : Configuration
- getOrganizationSamlRole() : object
- Operation getOrganizationSamlRole
- getOrganizationSamlRoleAsync() : PromiseInterface
- Operation getOrganizationSamlRoleAsync
- getOrganizationSamlRoleAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationSamlRoleAsyncWithHttpInfo
- getOrganizationSamlRoles() : object
- Operation getOrganizationSamlRoles
- getOrganizationSamlRolesAsync() : PromiseInterface
- Operation getOrganizationSamlRolesAsync
- getOrganizationSamlRolesAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationSamlRolesAsyncWithHttpInfo
- getOrganizationSamlRolesWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationSamlRolesWithHttpInfo
- getOrganizationSamlRoleWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationSamlRoleWithHttpInfo
- updateOrganizationSamlRole() : object
- Operation updateOrganizationSamlRole
- updateOrganizationSamlRoleAsync() : PromiseInterface
- Operation updateOrganizationSamlRoleAsync
- updateOrganizationSamlRoleAsyncWithHttpInfo() : PromiseInterface
- Operation updateOrganizationSamlRoleAsyncWithHttpInfo
- updateOrganizationSamlRoleWithHttpInfo() : array<string|int, mixed>
- Operation updateOrganizationSamlRoleWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- createOrganizationSamlRoleRequest() : Request
- Create request for operation 'createOrganizationSamlRole'
- deleteOrganizationSamlRoleRequest() : Request
- Create request for operation 'deleteOrganizationSamlRole'
- getOrganizationSamlRoleRequest() : Request
- Create request for operation 'getOrganizationSamlRole'
- getOrganizationSamlRolesRequest() : Request
- Create request for operation 'getOrganizationSamlRoles'
- updateOrganizationSamlRoleRequest() : Request
- Create request for operation 'updateOrganizationSamlRole'
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 —createOrganizationSamlRole()
Operation createOrganizationSamlRole
public
createOrganizationSamlRole(string $organization_id, CreateOrganizationSamlRole $create_organization_saml_role) : object
Create a SAML role
Parameters
- $organization_id : string
-
organization_id (required)
- $create_organization_saml_role : CreateOrganizationSamlRole
-
create_organization_saml_role (required)
Tags
Return values
object —createOrganizationSamlRoleAsync()
Operation createOrganizationSamlRoleAsync
public
createOrganizationSamlRoleAsync(string $organization_id, CreateOrganizationSamlRole $create_organization_saml_role) : PromiseInterface
Create a SAML role
Parameters
- $organization_id : string
-
(required)
- $create_organization_saml_role : CreateOrganizationSamlRole
-
(required)
Tags
Return values
PromiseInterface —createOrganizationSamlRoleAsyncWithHttpInfo()
Operation createOrganizationSamlRoleAsyncWithHttpInfo
public
createOrganizationSamlRoleAsyncWithHttpInfo(string $organization_id, CreateOrganizationSamlRole $create_organization_saml_role) : PromiseInterface
Create a SAML role
Parameters
- $organization_id : string
-
(required)
- $create_organization_saml_role : CreateOrganizationSamlRole
-
(required)
Tags
Return values
PromiseInterface —createOrganizationSamlRoleWithHttpInfo()
Operation createOrganizationSamlRoleWithHttpInfo
public
createOrganizationSamlRoleWithHttpInfo(string $organization_id, CreateOrganizationSamlRole $create_organization_saml_role) : array<string|int, mixed>
Create a SAML role
Parameters
- $organization_id : string
-
(required)
- $create_organization_saml_role : CreateOrganizationSamlRole
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
deleteOrganizationSamlRole()
Operation deleteOrganizationSamlRole
public
deleteOrganizationSamlRole(string $organization_id, string $saml_role_id) : void
Remove a SAML role
Parameters
- $organization_id : string
-
organization_id (required)
- $saml_role_id : string
-
saml_role_id (required)
Tags
Return values
void —deleteOrganizationSamlRoleAsync()
Operation deleteOrganizationSamlRoleAsync
public
deleteOrganizationSamlRoleAsync(string $organization_id, string $saml_role_id) : PromiseInterface
Remove a SAML role
Parameters
- $organization_id : string
-
(required)
- $saml_role_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteOrganizationSamlRoleAsyncWithHttpInfo()
Operation deleteOrganizationSamlRoleAsyncWithHttpInfo
public
deleteOrganizationSamlRoleAsyncWithHttpInfo(string $organization_id, string $saml_role_id) : PromiseInterface
Remove a SAML role
Parameters
- $organization_id : string
-
(required)
- $saml_role_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteOrganizationSamlRoleWithHttpInfo()
Operation deleteOrganizationSamlRoleWithHttpInfo
public
deleteOrganizationSamlRoleWithHttpInfo(string $organization_id, string $saml_role_id) : array<string|int, mixed>
Remove a SAML role
Parameters
- $organization_id : string
-
(required)
- $saml_role_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 —getOrganizationSamlRole()
Operation getOrganizationSamlRole
public
getOrganizationSamlRole(string $organization_id, string $saml_role_id) : object
Return a SAML role
Parameters
- $organization_id : string
-
organization_id (required)
- $saml_role_id : string
-
saml_role_id (required)
Tags
Return values
object —getOrganizationSamlRoleAsync()
Operation getOrganizationSamlRoleAsync
public
getOrganizationSamlRoleAsync(string $organization_id, string $saml_role_id) : PromiseInterface
Return a SAML role
Parameters
- $organization_id : string
-
(required)
- $saml_role_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationSamlRoleAsyncWithHttpInfo()
Operation getOrganizationSamlRoleAsyncWithHttpInfo
public
getOrganizationSamlRoleAsyncWithHttpInfo(string $organization_id, string $saml_role_id) : PromiseInterface
Return a SAML role
Parameters
- $organization_id : string
-
(required)
- $saml_role_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationSamlRoles()
Operation getOrganizationSamlRoles
public
getOrganizationSamlRoles(string $organization_id) : object
List the SAML roles for this organization
Parameters
- $organization_id : string
-
organization_id (required)
Tags
Return values
object —getOrganizationSamlRolesAsync()
Operation getOrganizationSamlRolesAsync
public
getOrganizationSamlRolesAsync(string $organization_id) : PromiseInterface
List the SAML roles for this organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationSamlRolesAsyncWithHttpInfo()
Operation getOrganizationSamlRolesAsyncWithHttpInfo
public
getOrganizationSamlRolesAsyncWithHttpInfo(string $organization_id) : PromiseInterface
List the SAML roles for this organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationSamlRolesWithHttpInfo()
Operation getOrganizationSamlRolesWithHttpInfo
public
getOrganizationSamlRolesWithHttpInfo(string $organization_id) : array<string|int, mixed>
List the SAML roles for this organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationSamlRoleWithHttpInfo()
Operation getOrganizationSamlRoleWithHttpInfo
public
getOrganizationSamlRoleWithHttpInfo(string $organization_id, string $saml_role_id) : array<string|int, mixed>
Return a SAML role
Parameters
- $organization_id : string
-
(required)
- $saml_role_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateOrganizationSamlRole()
Operation updateOrganizationSamlRole
public
updateOrganizationSamlRole(string $organization_id, string $saml_role_id[, UpdateOrganizationSamlRole $update_organization_saml_role = null ]) : object
Update a SAML role
Parameters
- $organization_id : string
-
organization_id (required)
- $saml_role_id : string
-
saml_role_id (required)
- $update_organization_saml_role : UpdateOrganizationSamlRole = null
-
update_organization_saml_role (optional)
Tags
Return values
object —updateOrganizationSamlRoleAsync()
Operation updateOrganizationSamlRoleAsync
public
updateOrganizationSamlRoleAsync(string $organization_id, string $saml_role_id[, UpdateOrganizationSamlRole $update_organization_saml_role = null ]) : PromiseInterface
Update a SAML role
Parameters
- $organization_id : string
-
(required)
- $saml_role_id : string
-
(required)
- $update_organization_saml_role : UpdateOrganizationSamlRole = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationSamlRoleAsyncWithHttpInfo()
Operation updateOrganizationSamlRoleAsyncWithHttpInfo
public
updateOrganizationSamlRoleAsyncWithHttpInfo(string $organization_id, string $saml_role_id[, UpdateOrganizationSamlRole $update_organization_saml_role = null ]) : PromiseInterface
Update a SAML role
Parameters
- $organization_id : string
-
(required)
- $saml_role_id : string
-
(required)
- $update_organization_saml_role : UpdateOrganizationSamlRole = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationSamlRoleWithHttpInfo()
Operation updateOrganizationSamlRoleWithHttpInfo
public
updateOrganizationSamlRoleWithHttpInfo(string $organization_id, string $saml_role_id[, UpdateOrganizationSamlRole $update_organization_saml_role = null ]) : array<string|int, mixed>
Update a SAML role
Parameters
- $organization_id : string
-
(required)
- $saml_role_id : string
-
(required)
- $update_organization_saml_role : UpdateOrganizationSamlRole = 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
createOrganizationSamlRoleRequest()
Create request for operation 'createOrganizationSamlRole'
protected
createOrganizationSamlRoleRequest(string $organization_id, CreateOrganizationSamlRole $create_organization_saml_role) : Request
Parameters
- $organization_id : string
-
(required)
- $create_organization_saml_role : CreateOrganizationSamlRole
-
(required)
Tags
Return values
Request —deleteOrganizationSamlRoleRequest()
Create request for operation 'deleteOrganizationSamlRole'
protected
deleteOrganizationSamlRoleRequest(string $organization_id, string $saml_role_id) : Request
Parameters
- $organization_id : string
-
(required)
- $saml_role_id : string
-
(required)
Tags
Return values
Request —getOrganizationSamlRoleRequest()
Create request for operation 'getOrganizationSamlRole'
protected
getOrganizationSamlRoleRequest(string $organization_id, string $saml_role_id) : Request
Parameters
- $organization_id : string
-
(required)
- $saml_role_id : string
-
(required)
Tags
Return values
Request —getOrganizationSamlRolesRequest()
Create request for operation 'getOrganizationSamlRoles'
protected
getOrganizationSamlRolesRequest(string $organization_id) : Request
Parameters
- $organization_id : string
-
(required)
Tags
Return values
Request —updateOrganizationSamlRoleRequest()
Create request for operation 'updateOrganizationSamlRole'
protected
updateOrganizationSamlRoleRequest(string $organization_id, string $saml_role_id[, UpdateOrganizationSamlRole $update_organization_saml_role = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $saml_role_id : string
-
(required)
- $update_organization_saml_role : UpdateOrganizationSamlRole = null
-
(optional)