Skip to main content
Ctrl+K
IAM-SDK

IAM-SDK

Site Navigation

  • Getting Started
  • Configuration
  • SDK Reference
  • Examples
Ctrl+K

Site Navigation

  • Getting Started
  • Configuration
  • SDK Reference
  • Examples
Ctrl+K

Section Navigation

  • ntnx_iam_py_client package
    • api package
      • authorization_policies_api
      • certificate_authentication_providers_api
      • clients_api
      • directory_services_api
      • entities_api
      • operations_api
      • roles_api
      • saml_identity_providers_api
      • user_groups_api
      • users_api
    • models package
      • common package
        • v1 package
          • config package
            • Flag
            • KVPair
            • MapOfStringWrapper
            • Message
            • MessageSeverity
            • TenantAwareModel
          • response package
            • ApiLink
            • ApiResponseMetadata
            • ExternalizableAbstractModel
      • iam package
        • v4 package
          • authn package
            • ActivateUserApiResponse
            • AlgoType
            • ApiKeyDetails
            • AuthMethodType
            • BucketsAccessKey
            • BucketsAccessKeyStatusType
            • CertAuthProvider
            • CertRevocationInfo
            • ChangeUserPasswordApiResponse
            • ClaimsType
            • ConnectionDirectoryServiceApiResponse
            • CreateCertAuthProviderApiResponse
            • CreateDirectoryServiceApiResponse
            • CreateKeyApiResponse
            • CreateSamlIdentityProviderApiResponse
            • CreateUserApiResponse
            • CreateUserGroupApiResponse
            • CreateUserKeyApiResponse
            • CreationType
            • DeleteCertAuthProviderApiResponse
            • DeleteDirectoryServiceApiResponse
            • DeleteSamlIdentityProviderApiResponse
            • DeleteUserApiResponse
            • DeleteUserGroupApiResponse
            • DeleteUserKeyApiResponse
            • DirectoryService
            • DirectoryServiceConnectionRequest
            • DirectoryServiceConnectionResponse
            • DirectoryServiceInfo
            • DirectoryServiceInfoGroup
            • DirectoryServiceInfoOu
            • DirectoryServiceSearchAttribute
            • DirectoryServiceSearchEntity
            • DirectoryServiceSearchQuery
            • DirectoryServiceSearchResult
            • DirectoryType
            • DiscoverySubjectType
            • DsServiceAccount
            • Federation
            • FederationClaims
            • GetCertAuthProviderApiResponse
            • GetDirectoryServiceApiResponse
            • GetSamlIdentityProviderApiResponse
            • GetSamlSpMetadataApiResponse
            • GetUserApiResponse
            • GetUserBucketKeyApiResponse
            • GetUserGroupApiResponse
            • GetUserKeyApiResponse
            • GrantType
            • Group
            • GroupSearchType
            • GroupType
            • IdpMetadata
            • Key
            • KeyKind
            • KeyMigrationSpec
            • KeyStatus
            • KeyType
            • ListCertAuthProvidersApiResponse
            • ListDirectoryServicesApiResponse
            • ListSamlIdentityProvidersApiResponse
            • ListUserBucketKeysApiResponse
            • ListUserGroupsApiResponse
            • ListUserKeysApiResponse
            • ListUsersApiResponse
            • NameIdPolicyFormat
            • ObjectKeyDetails
            • ObjectsAuthDetails
            • ObjectsAuthSpec
            • OidcKey
            • OidcSubjectType
            • OidcUserinfo
            • OpenLdapConfig
            • PasswordChangeRequest
            • PasswordChangeResponse
            • PasswordResetRequest
            • PasswordResetResponse
            • ResetUserPasswordApiResponse
            • ResponseType
            • RevokeUserBucketKeyApiResponse
            • RevokeUserKeyApiResponse
            • SamlIdentityProvider
            • ScopesType
            • SearchDirectoryServiceApiResponse
            • SecretKeyRequest
            • SecretKeyResponse
            • SigningAlgoType
            • SubjectType
            • SystemConfig
            • Tenant
            • TokenRequest
            • UpdateCertAuthProviderApiResponse
            • UpdateDirectoryServiceApiResponse
            • UpdateSamlIdentityProviderApiResponse
            • UpdateSystemConfigApiResponse
            • UpdateUserApiResponse
            • UseType
            • User
            • UserBucketKeyRevokeResponse
            • UserConfiguration
            • UserGroup
            • UserGroupConfiguration
            • UserStateUpdate
            • UserStateUpdateResponse
            • UserStatusType
            • UserType
          • authz package
            • ApiVersion
            • AssociatedEndpoint
            • AttributeEntity
            • AuthorizationPolicy
            • AuthorizationPolicyProjection
            • AuthorizationPolicyType
            • AuthorizationRequest
            • AuthorizationResponse
            • AuthorizationResponseObject
            • AuthorizeEntity
            • BaseAuthorizationPolicy
            • BaseAuthorizationPolicyProjection
            • BaseRole
            • BaseRoleProjection
            • Client
            • CreateAuthorizationPolicyApiResponse
            • CreateRoleApiResponse
            • DeleteAuthorizationPolicyApiResponse
            • DeleteRoleApiResponse
            • Entity
            • EntityFilter
            • EntityOperators
            • GetAuthorizationPolicyApiResponse
            • GetClientApiResponse
            • GetEntityApiResponse
            • GetOperationApiResponse
            • GetRoleApiResponse
            • HttpMethod
            • IdentityFilter
            • IdentityObject
            • IdentityType
            • ListAuthorizationPoliciesApiResponse
            • ListEntitiesApiResponse
            • ListOperationsApiResponse
            • ListRolesApiResponse
            • Operation
            • OperationType
            • RequestObject
            • ResponseType
            • Role
            • RoleProjection
            • Tenant
            • UpdateAuthorizationPolicyApiResponse
            • UpdateClientApiResponse
            • UpdateRoleApiResponse
            • UserAuthorizationPolicy
            • UserRole
            • UserRoleProjection
          • common package
            • ActionBaseResponse
            • SchemaValidationError
            • SchemaValidationErrorMessage
            • SchemaValidationErrorResponse
            • SortOrderType
            • ValidationErrorMessage
          • error package
            • AppMessage
            • ErrorResponse
            • SchemaValidationError
            • SchemaValidationErrorMessage
          • tenant package
            • Tenant
    • api_client
    • api_response
    • configuration
    • custom_retry
    • rest
  • ntnx_iam_py_client
  • response package
  • ApiLink

ApiLink#

class ApiLink(href=None, rel=None, *args, **kwargs)#

Bases: object

A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.

Parameters:
  • href – (href) The URL at which the entity described by the link can be accessed.

  • rel – (rel) A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of “self” identifies the URL for the object.

property href#

The URL at which the entity described by the link can be accessed.

Type:

str

property rel#

A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of “self” identifies the URL for the object.

Type:

str

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model

previous

response package

next

ApiResponseMetadata

© Copyright 2024, Nutanix.

Created using Sphinx 5.3.0.

Built with the PyData Sphinx Theme 0.13.0.