memos-script/docs/IdentityProviderServiceApi.md
2024-04-30 10:31:09 +08:00

8.4 KiB

memos.IdentityProviderServiceApi

All URIs are relative to /

Method HTTP request Description
identity_provider_service_create_identity_provider POST /api/v1/identityProviders CreateIdentityProvider creates an identity provider.
identity_provider_service_delete_identity_provider DELETE /api/v1/{name_1} DeleteIdentityProvider deletes an identity provider.
identity_provider_service_get_identity_provider GET /api/v1/{name_1} GetIdentityProvider gets an identity provider.
identity_provider_service_list_identity_providers GET /api/v1/identityProviders ListIdentityProviders lists identity providers.
identity_provider_service_update_identity_provider PATCH /api/v1/{identityProvider.name} UpdateIdentityProvider updates an identity provider.

identity_provider_service_create_identity_provider

Apiv1IdentityProvider identity_provider_service_create_identity_provider(body)

CreateIdentityProvider creates an identity provider.

Example

from __future__ import print_function
import time
import memos
from memos.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = memos.IdentityProviderServiceApi()
body = memos.Apiv1IdentityProvider() # Apiv1IdentityProvider | The identityProvider to create.

try:
    # CreateIdentityProvider creates an identity provider.
    api_response = api_instance.identity_provider_service_create_identity_provider(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IdentityProviderServiceApi->identity_provider_service_create_identity_provider: %s\n" % e)

Parameters

Name Type Description Notes
body Apiv1IdentityProvider The identityProvider to create.

Return type

Apiv1IdentityProvider

Authorization

No authorization required

HTTP request headers

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

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

identity_provider_service_delete_identity_provider

object identity_provider_service_delete_identity_provider(name_1)

DeleteIdentityProvider deletes an identity provider.

Example

from __future__ import print_function
import time
import memos
from memos.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = memos.IdentityProviderServiceApi()
name_1 = 'name_1_example' # str | The name of the identityProvider to delete. Format: identityProviders/{id}

try:
    # DeleteIdentityProvider deletes an identity provider.
    api_response = api_instance.identity_provider_service_delete_identity_provider(name_1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IdentityProviderServiceApi->identity_provider_service_delete_identity_provider: %s\n" % e)

Parameters

Name Type Description Notes
name_1 str The name of the identityProvider to delete. Format: identityProviders/{id}

Return type

object

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

identity_provider_service_get_identity_provider

Apiv1IdentityProvider identity_provider_service_get_identity_provider(name_1)

GetIdentityProvider gets an identity provider.

Example

from __future__ import print_function
import time
import memos
from memos.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = memos.IdentityProviderServiceApi()
name_1 = 'name_1_example' # str | The name of the identityProvider to get. Format: identityProviders/{id}

try:
    # GetIdentityProvider gets an identity provider.
    api_response = api_instance.identity_provider_service_get_identity_provider(name_1)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IdentityProviderServiceApi->identity_provider_service_get_identity_provider: %s\n" % e)

Parameters

Name Type Description Notes
name_1 str The name of the identityProvider to get. Format: identityProviders/{id}

Return type

Apiv1IdentityProvider

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

identity_provider_service_list_identity_providers

V1ListIdentityProvidersResponse identity_provider_service_list_identity_providers()

ListIdentityProviders lists identity providers.

Example

from __future__ import print_function
import time
import memos
from memos.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = memos.IdentityProviderServiceApi()

try:
    # ListIdentityProviders lists identity providers.
    api_response = api_instance.identity_provider_service_list_identity_providers()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IdentityProviderServiceApi->identity_provider_service_list_identity_providers: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

V1ListIdentityProvidersResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

identity_provider_service_update_identity_provider

Apiv1IdentityProvider identity_provider_service_update_identity_provider(body, identity_provider_name)

UpdateIdentityProvider updates an identity provider.

Example

from __future__ import print_function
import time
import memos
from memos.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = memos.IdentityProviderServiceApi()
body = memos.TheIdentityProviderToUpdate_() # TheIdentityProviderToUpdate_ | The identityProvider to update.
identity_provider_name = 'identity_provider_name_example' # str | The name of the identityProvider. Format: identityProviders/{id}

try:
    # UpdateIdentityProvider updates an identity provider.
    api_response = api_instance.identity_provider_service_update_identity_provider(body, identity_provider_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IdentityProviderServiceApi->identity_provider_service_update_identity_provider: %s\n" % e)

Parameters

Name Type Description Notes
body TheIdentityProviderToUpdate_ The identityProvider to update.
identity_provider_name str The name of the identityProvider. Format: identityProviders/{id}

Return type

Apiv1IdentityProvider

Authorization

No authorization required

HTTP request headers

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

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