intersight.getIamAppRegistration

func LookupIamAppRegistration(ctx *Context, args *LookupIamAppRegistrationArgs, opts ...InvokeOption) (*LookupIamAppRegistrationResult, error)
func LookupIamAppRegistrationOutput(ctx *Context, args *LookupIamAppRegistrationOutputArgs, opts ...InvokeOption) LookupIamAppRegistrationResultOutput

> Note: This function is named LookupIamAppRegistration in the Go SDK.

Account GetIamAppRegistrationAccount

AccountMoid string

The Account ID for this managed object.

AdditionalProperties string

AdminStatus string

Used to trigger the enable or disable action on the App Registration. These actions change the status of an App Registration.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.

Ancestors List<GetIamAppRegistrationAncestor>

ClassId string

ClientApplication GetIamAppRegistrationClientApplication

ClientId string

A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.

ClientName string

App Registration name specified by user.

ClientSecret string

The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.

ClientType string

The type of the OAuth2 client (public or confidential), as specified in https://tools.ietf.org/html/rfc6749#section-2.1.* public - Clients incapable of maintaining the confidentiality of their credentials.This includes clients executing on the device used by the resource owner,such as mobile applications, installed native application or a webbrowser-based application.* confidential - Clients capable of maintaining the confidentiality of their credentials.For example, this could be a client implemented on a secure server withrestricted access to the client credentials.To maintain the confidentiality of the OAuth2 credentials, two use cases areconsidered.1) The application is running as a service within Intersight. The application automatically obtains the OAuth2 credentials when the application starts and the credentials are not exposed to the end-user. Because end-users (even account administrators) do not have access the OAuth2 credentials, they cannot take the credentials with them when they leave their organization.2) The application is under the control of a \ trusted\ end-user. For example, the end-user may create a native application running outside Intersight. The application uses OAuth2 credentials to interact with the Intersight API. In that case, the Intersight account administrator may generate OAuth2 credentials with a registered application using \ client_credentials\ grant type. In that case, the end-user is responsible for maintaining the confidentiality of the OAuth2 credentials. If the end-user leaves the organization, you should revoke the credentials and issue new Oauth2 credentials.Here is a possible workflow for handling OAuth2 tokens.1) User Alice (Intersight Account Administrator) logins to Intersight and deploys an Intersight application that requires an OAuth2 token.2) Intersight automatically deploys the application. The application is assigned a OAuth2 token, possibly linked to Alice. The application must NOT expose the OAuth2 secret to Alice, otherwise Alice would be able to use the token after she leaves the company.3) The application can make API calls to Intersight using its assigned OAuth2 token. For example, the application could make weekly scheduled API calls to Intersight.4) Separately, Alice may also get OAuth2 tokens that she can use to make API calls from the Intersight SDK through the northbound API. In that case, Alice will get the associated OAuth2 secrets, but not the one assigned in step #2.5) Alice leaves the organization. The OAuth2 tokens assigned in step #2 must retain their validity even after Alice has left the organization. Because the OAuth2 secrets were never shared with Alice, there is no risk Alice can reuse the OAuth2 secrets. On the other hand, the OAuth2 tokens assigned in step #4 must be invalidated because Alice had the OAuth2 tokens in her possession.

CreateTime string

The time when this managed object was created.

Description string

Description of the application.

DomainGroupMoid string

The DomainGroup ID for this managed object.

EntityId string

EntityId holds the Id of the client application that is using this AppRegistration.

ExpiryDateTime string

The expiration date of the App Registration which is set at the time of its creation. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the App Registration to the maximum expiry time configured at the account level.

GrantTypes List<string>

Id string

IsNeverExpiring bool

Used to mark the App Registration as a never-expiring App Registration.

LastUsedIp string

The ip address from which the App Registration was last used.

LastUsedTime string

The time at which the App Registration was last used. It is updated every 24 hours.

ModTime string

The time when this managed object was last modified.

Moid string

The unique identifier of this Managed Object instance.

OauthTokens List<GetIamAppRegistrationOauthToken>

ObjectType string

OperStatus string

The current status of the App Registration that dictates the validity of the app.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.

Owners List<string>

Parent GetIamAppRegistrationParent

Permission GetIamAppRegistrationPermission

PermissionResources List<GetIamAppRegistrationPermissionResource>

RedirectUris List<string>

RenewClientSecret bool

Set value to true to renew the client-secret. Applicable to client_credentials grant type.

ResponseTypes List<string>

RevocationTimestamp string

Used to perform revocation for tokens of AppRegistration.Updated only internally is case Revoke property come from UI with value true.On each request with OAuth2 access token the CreationTime of the OAuth2 token will be compared to RevokationTimestamp of thecorresponding App Registration.

Revoke bool

Used to trigger update the revocationTimestamp value.If UI sent updating request with the Revoke value is true, then update RevocationTimestamp.

Roles List<GetIamAppRegistrationRole>

Scope GetIamAppRegistrationScope

SecurityHolder GetIamAppRegistrationSecurityHolder

SharedScope string

Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.

ShowConsentScreen bool

Set to true if consent screen needs to be shown during the OAuth login process.Applicable only for public AppRegistrations, means only 'authorization_code' grantType.Note that consent screen will be shown on each login.

StartTime string

The timestamp at which an expiry date was first set on this app registration. For expiring App Registrations, this field is same as the create time of the App Registration.For never-expiring App Registrations, this field is set initially to zero time value. If a never-expiry App Registration is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.

Tags List<GetIamAppRegistrationTag>

TokenExpiry string

Defines the expiry time of the token generated via the AppRegistration.* generic - This sets the expiryTime to ten minutes from the token issuing time.* longLived - This sets the expiryTime to an year from the token issuing time.* infinite - This allows for a never-expiring token. Use with caution.

User GetIamAppRegistrationUser

VersionContext GetIamAppRegistrationVersionContext

Account GetIamAppRegistrationAccount

AccountMoid string

The Account ID for this managed object.

AdditionalProperties string

AdminStatus string

Used to trigger the enable or disable action on the App Registration. These actions change the status of an App Registration.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.

Ancestors []GetIamAppRegistrationAncestor

ClassId string

ClientApplication GetIamAppRegistrationClientApplication

ClientId string

A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.

ClientName string

App Registration name specified by user.

ClientSecret string

The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.

ClientType string

The type of the OAuth2 client (public or confidential), as specified in https://tools.ietf.org/html/rfc6749#section-2.1.* public - Clients incapable of maintaining the confidentiality of their credentials.This includes clients executing on the device used by the resource owner,such as mobile applications, installed native application or a webbrowser-based application.* confidential - Clients capable of maintaining the confidentiality of their credentials.For example, this could be a client implemented on a secure server withrestricted access to the client credentials.To maintain the confidentiality of the OAuth2 credentials, two use cases areconsidered.1) The application is running as a service within Intersight. The application automatically obtains the OAuth2 credentials when the application starts and the credentials are not exposed to the end-user. Because end-users (even account administrators) do not have access the OAuth2 credentials, they cannot take the credentials with them when they leave their organization.2) The application is under the control of a \ trusted\ end-user. For example, the end-user may create a native application running outside Intersight. The application uses OAuth2 credentials to interact with the Intersight API. In that case, the Intersight account administrator may generate OAuth2 credentials with a registered application using \ client_credentials\ grant type. In that case, the end-user is responsible for maintaining the confidentiality of the OAuth2 credentials. If the end-user leaves the organization, you should revoke the credentials and issue new Oauth2 credentials.Here is a possible workflow for handling OAuth2 tokens.1) User Alice (Intersight Account Administrator) logins to Intersight and deploys an Intersight application that requires an OAuth2 token.2) Intersight automatically deploys the application. The application is assigned a OAuth2 token, possibly linked to Alice. The application must NOT expose the OAuth2 secret to Alice, otherwise Alice would be able to use the token after she leaves the company.3) The application can make API calls to Intersight using its assigned OAuth2 token. For example, the application could make weekly scheduled API calls to Intersight.4) Separately, Alice may also get OAuth2 tokens that she can use to make API calls from the Intersight SDK through the northbound API. In that case, Alice will get the associated OAuth2 secrets, but not the one assigned in step #2.5) Alice leaves the organization. The OAuth2 tokens assigned in step #2 must retain their validity even after Alice has left the organization. Because the OAuth2 secrets were never shared with Alice, there is no risk Alice can reuse the OAuth2 secrets. On the other hand, the OAuth2 tokens assigned in step #4 must be invalidated because Alice had the OAuth2 tokens in her possession.

CreateTime string

The time when this managed object was created.

Description string

Description of the application.

DomainGroupMoid string

The DomainGroup ID for this managed object.

EntityId string

EntityId holds the Id of the client application that is using this AppRegistration.

ExpiryDateTime string

The expiration date of the App Registration which is set at the time of its creation. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the App Registration to the maximum expiry time configured at the account level.

GrantTypes []string

Id string

IsNeverExpiring bool

Used to mark the App Registration as a never-expiring App Registration.

LastUsedIp string

The ip address from which the App Registration was last used.

LastUsedTime string

The time at which the App Registration was last used. It is updated every 24 hours.

ModTime string

The time when this managed object was last modified.

Moid string

The unique identifier of this Managed Object instance.

OauthTokens []GetIamAppRegistrationOauthToken

ObjectType string

OperStatus string

The current status of the App Registration that dictates the validity of the app.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.

Owners []string

Parent GetIamAppRegistrationParent

Permission GetIamAppRegistrationPermission

PermissionResources []GetIamAppRegistrationPermissionResource

RedirectUris []string

RenewClientSecret bool

Set value to true to renew the client-secret. Applicable to client_credentials grant type.

ResponseTypes []string

RevocationTimestamp string

Used to perform revocation for tokens of AppRegistration.Updated only internally is case Revoke property come from UI with value true.On each request with OAuth2 access token the CreationTime of the OAuth2 token will be compared to RevokationTimestamp of thecorresponding App Registration.

Revoke bool

Used to trigger update the revocationTimestamp value.If UI sent updating request with the Revoke value is true, then update RevocationTimestamp.

Roles []GetIamAppRegistrationRole

Scope GetIamAppRegistrationScope

SecurityHolder GetIamAppRegistrationSecurityHolder

SharedScope string

Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.

ShowConsentScreen bool

Set to true if consent screen needs to be shown during the OAuth login process.Applicable only for public AppRegistrations, means only 'authorization_code' grantType.Note that consent screen will be shown on each login.

StartTime string

The timestamp at which an expiry date was first set on this app registration. For expiring App Registrations, this field is same as the create time of the App Registration.For never-expiring App Registrations, this field is set initially to zero time value. If a never-expiry App Registration is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.

Tags []GetIamAppRegistrationTag

TokenExpiry string

Defines the expiry time of the token generated via the AppRegistration.* generic - This sets the expiryTime to ten minutes from the token issuing time.* longLived - This sets the expiryTime to an year from the token issuing time.* infinite - This allows for a never-expiring token. Use with caution.

User GetIamAppRegistrationUser

VersionContext GetIamAppRegistrationVersionContext

account GetIamAppRegistrationAccount

accountMoid String

The Account ID for this managed object.

additionalProperties String

adminStatus String

Used to trigger the enable or disable action on the App Registration. These actions change the status of an App Registration.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.

ancestors List<GetIamAppRegistrationAncestor>

classId String

clientApplication GetIamAppRegistrationClientApplication

clientId String

A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.

clientName String

App Registration name specified by user.

clientSecret String

The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.

clientType String

The type of the OAuth2 client (public or confidential), as specified in https://tools.ietf.org/html/rfc6749#section-2.1.* public - Clients incapable of maintaining the confidentiality of their credentials.This includes clients executing on the device used by the resource owner,such as mobile applications, installed native application or a webbrowser-based application.* confidential - Clients capable of maintaining the confidentiality of their credentials.For example, this could be a client implemented on a secure server withrestricted access to the client credentials.To maintain the confidentiality of the OAuth2 credentials, two use cases areconsidered.1) The application is running as a service within Intersight. The application automatically obtains the OAuth2 credentials when the application starts and the credentials are not exposed to the end-user. Because end-users (even account administrators) do not have access the OAuth2 credentials, they cannot take the credentials with them when they leave their organization.2) The application is under the control of a \ trusted\ end-user. For example, the end-user may create a native application running outside Intersight. The application uses OAuth2 credentials to interact with the Intersight API. In that case, the Intersight account administrator may generate OAuth2 credentials with a registered application using \ client_credentials\ grant type. In that case, the end-user is responsible for maintaining the confidentiality of the OAuth2 credentials. If the end-user leaves the organization, you should revoke the credentials and issue new Oauth2 credentials.Here is a possible workflow for handling OAuth2 tokens.1) User Alice (Intersight Account Administrator) logins to Intersight and deploys an Intersight application that requires an OAuth2 token.2) Intersight automatically deploys the application. The application is assigned a OAuth2 token, possibly linked to Alice. The application must NOT expose the OAuth2 secret to Alice, otherwise Alice would be able to use the token after she leaves the company.3) The application can make API calls to Intersight using its assigned OAuth2 token. For example, the application could make weekly scheduled API calls to Intersight.4) Separately, Alice may also get OAuth2 tokens that she can use to make API calls from the Intersight SDK through the northbound API. In that case, Alice will get the associated OAuth2 secrets, but not the one assigned in step #2.5) Alice leaves the organization. The OAuth2 tokens assigned in step #2 must retain their validity even after Alice has left the organization. Because the OAuth2 secrets were never shared with Alice, there is no risk Alice can reuse the OAuth2 secrets. On the other hand, the OAuth2 tokens assigned in step #4 must be invalidated because Alice had the OAuth2 tokens in her possession.

createTime String

The time when this managed object was created.

description String

Description of the application.

domainGroupMoid String

The DomainGroup ID for this managed object.

entityId String

EntityId holds the Id of the client application that is using this AppRegistration.

expiryDateTime String

The expiration date of the App Registration which is set at the time of its creation. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the App Registration to the maximum expiry time configured at the account level.

grantTypes List<String>

id String

isNeverExpiring Boolean

Used to mark the App Registration as a never-expiring App Registration.

lastUsedIp String

The ip address from which the App Registration was last used.

lastUsedTime String

The time at which the App Registration was last used. It is updated every 24 hours.

modTime String

The time when this managed object was last modified.

moid String

The unique identifier of this Managed Object instance.

oauthTokens List<GetIamAppRegistrationOauthToken>

objectType String

operStatus String

The current status of the App Registration that dictates the validity of the app.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.

owners List<String>

parent GetIamAppRegistrationParent

permission GetIamAppRegistrationPermission

permissionResources List<GetIamAppRegistrationPermissionResource>

redirectUris List<String>

renewClientSecret Boolean

Set value to true to renew the client-secret. Applicable to client_credentials grant type.

responseTypes List<String>

revocationTimestamp String

Used to perform revocation for tokens of AppRegistration.Updated only internally is case Revoke property come from UI with value true.On each request with OAuth2 access token the CreationTime of the OAuth2 token will be compared to RevokationTimestamp of thecorresponding App Registration.

revoke Boolean

Used to trigger update the revocationTimestamp value.If UI sent updating request with the Revoke value is true, then update RevocationTimestamp.

roles List<GetIamAppRegistrationRole>

scope GetIamAppRegistrationScope

securityHolder GetIamAppRegistrationSecurityHolder

sharedScope String

Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.

showConsentScreen Boolean

Set to true if consent screen needs to be shown during the OAuth login process.Applicable only for public AppRegistrations, means only 'authorization_code' grantType.Note that consent screen will be shown on each login.

startTime String

The timestamp at which an expiry date was first set on this app registration. For expiring App Registrations, this field is same as the create time of the App Registration.For never-expiring App Registrations, this field is set initially to zero time value. If a never-expiry App Registration is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.

tags List<GetIamAppRegistrationTag>

tokenExpiry String

Defines the expiry time of the token generated via the AppRegistration.* generic - This sets the expiryTime to ten minutes from the token issuing time.* longLived - This sets the expiryTime to an year from the token issuing time.* infinite - This allows for a never-expiring token. Use with caution.

user GetIamAppRegistrationUser

versionContext GetIamAppRegistrationVersionContext

account GetIamAppRegistrationAccount

accountMoid string

The Account ID for this managed object.

additionalProperties string

adminStatus string

Used to trigger the enable or disable action on the App Registration. These actions change the status of an App Registration.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.

ancestors GetIamAppRegistrationAncestor[]

classId string

clientApplication GetIamAppRegistrationClientApplication

clientId string

A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.

clientName string

App Registration name specified by user.

clientSecret string

The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.

clientType string

The type of the OAuth2 client (public or confidential), as specified in https://tools.ietf.org/html/rfc6749#section-2.1.* public - Clients incapable of maintaining the confidentiality of their credentials.This includes clients executing on the device used by the resource owner,such as mobile applications, installed native application or a webbrowser-based application.* confidential - Clients capable of maintaining the confidentiality of their credentials.For example, this could be a client implemented on a secure server withrestricted access to the client credentials.To maintain the confidentiality of the OAuth2 credentials, two use cases areconsidered.1) The application is running as a service within Intersight. The application automatically obtains the OAuth2 credentials when the application starts and the credentials are not exposed to the end-user. Because end-users (even account administrators) do not have access the OAuth2 credentials, they cannot take the credentials with them when they leave their organization.2) The application is under the control of a \ trusted\ end-user. For example, the end-user may create a native application running outside Intersight. The application uses OAuth2 credentials to interact with the Intersight API. In that case, the Intersight account administrator may generate OAuth2 credentials with a registered application using \ client_credentials\ grant type. In that case, the end-user is responsible for maintaining the confidentiality of the OAuth2 credentials. If the end-user leaves the organization, you should revoke the credentials and issue new Oauth2 credentials.Here is a possible workflow for handling OAuth2 tokens.1) User Alice (Intersight Account Administrator) logins to Intersight and deploys an Intersight application that requires an OAuth2 token.2) Intersight automatically deploys the application. The application is assigned a OAuth2 token, possibly linked to Alice. The application must NOT expose the OAuth2 secret to Alice, otherwise Alice would be able to use the token after she leaves the company.3) The application can make API calls to Intersight using its assigned OAuth2 token. For example, the application could make weekly scheduled API calls to Intersight.4) Separately, Alice may also get OAuth2 tokens that she can use to make API calls from the Intersight SDK through the northbound API. In that case, Alice will get the associated OAuth2 secrets, but not the one assigned in step #2.5) Alice leaves the organization. The OAuth2 tokens assigned in step #2 must retain their validity even after Alice has left the organization. Because the OAuth2 secrets were never shared with Alice, there is no risk Alice can reuse the OAuth2 secrets. On the other hand, the OAuth2 tokens assigned in step #4 must be invalidated because Alice had the OAuth2 tokens in her possession.

createTime string

The time when this managed object was created.

description string

Description of the application.

domainGroupMoid string

The DomainGroup ID for this managed object.

entityId string

EntityId holds the Id of the client application that is using this AppRegistration.

expiryDateTime string

The expiration date of the App Registration which is set at the time of its creation. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the App Registration to the maximum expiry time configured at the account level.

grantTypes string[]

id string

isNeverExpiring boolean

Used to mark the App Registration as a never-expiring App Registration.

lastUsedIp string

The ip address from which the App Registration was last used.

lastUsedTime string

The time at which the App Registration was last used. It is updated every 24 hours.

modTime string

The time when this managed object was last modified.

moid string

The unique identifier of this Managed Object instance.

oauthTokens GetIamAppRegistrationOauthToken[]

objectType string

operStatus string

The current status of the App Registration that dictates the validity of the app.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.

owners string[]

parent GetIamAppRegistrationParent

permission GetIamAppRegistrationPermission

permissionResources GetIamAppRegistrationPermissionResource[]

redirectUris string[]

renewClientSecret boolean

Set value to true to renew the client-secret. Applicable to client_credentials grant type.

responseTypes string[]

revocationTimestamp string

Used to perform revocation for tokens of AppRegistration.Updated only internally is case Revoke property come from UI with value true.On each request with OAuth2 access token the CreationTime of the OAuth2 token will be compared to RevokationTimestamp of thecorresponding App Registration.

revoke boolean

Used to trigger update the revocationTimestamp value.If UI sent updating request with the Revoke value is true, then update RevocationTimestamp.

roles GetIamAppRegistrationRole[]

scope GetIamAppRegistrationScope

securityHolder GetIamAppRegistrationSecurityHolder

sharedScope string

Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.

showConsentScreen boolean

Set to true if consent screen needs to be shown during the OAuth login process.Applicable only for public AppRegistrations, means only 'authorization_code' grantType.Note that consent screen will be shown on each login.

startTime string

The timestamp at which an expiry date was first set on this app registration. For expiring App Registrations, this field is same as the create time of the App Registration.For never-expiring App Registrations, this field is set initially to zero time value. If a never-expiry App Registration is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.

tags GetIamAppRegistrationTag[]

tokenExpiry string

Defines the expiry time of the token generated via the AppRegistration.* generic - This sets the expiryTime to ten minutes from the token issuing time.* longLived - This sets the expiryTime to an year from the token issuing time.* infinite - This allows for a never-expiring token. Use with caution.

user GetIamAppRegistrationUser

versionContext GetIamAppRegistrationVersionContext

account GetIamAppRegistrationAccount

account_moid str

The Account ID for this managed object.

additional_properties str

admin_status str

Used to trigger the enable or disable action on the App Registration. These actions change the status of an App Registration.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.

ancestors Sequence[GetIamAppRegistrationAncestor]

class_id str

client_application GetIamAppRegistrationClientApplication

client_id str

A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.

client_name str

App Registration name specified by user.

client_secret str

The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.

client_type str

The type of the OAuth2 client (public or confidential), as specified in https://tools.ietf.org/html/rfc6749#section-2.1.* public - Clients incapable of maintaining the confidentiality of their credentials.This includes clients executing on the device used by the resource owner,such as mobile applications, installed native application or a webbrowser-based application.* confidential - Clients capable of maintaining the confidentiality of their credentials.For example, this could be a client implemented on a secure server withrestricted access to the client credentials.To maintain the confidentiality of the OAuth2 credentials, two use cases areconsidered.1) The application is running as a service within Intersight. The application automatically obtains the OAuth2 credentials when the application starts and the credentials are not exposed to the end-user. Because end-users (even account administrators) do not have access the OAuth2 credentials, they cannot take the credentials with them when they leave their organization.2) The application is under the control of a \ trusted\ end-user. For example, the end-user may create a native application running outside Intersight. The application uses OAuth2 credentials to interact with the Intersight API. In that case, the Intersight account administrator may generate OAuth2 credentials with a registered application using \ client_credentials\ grant type. In that case, the end-user is responsible for maintaining the confidentiality of the OAuth2 credentials. If the end-user leaves the organization, you should revoke the credentials and issue new Oauth2 credentials.Here is a possible workflow for handling OAuth2 tokens.1) User Alice (Intersight Account Administrator) logins to Intersight and deploys an Intersight application that requires an OAuth2 token.2) Intersight automatically deploys the application. The application is assigned a OAuth2 token, possibly linked to Alice. The application must NOT expose the OAuth2 secret to Alice, otherwise Alice would be able to use the token after she leaves the company.3) The application can make API calls to Intersight using its assigned OAuth2 token. For example, the application could make weekly scheduled API calls to Intersight.4) Separately, Alice may also get OAuth2 tokens that she can use to make API calls from the Intersight SDK through the northbound API. In that case, Alice will get the associated OAuth2 secrets, but not the one assigned in step #2.5) Alice leaves the organization. The OAuth2 tokens assigned in step #2 must retain their validity even after Alice has left the organization. Because the OAuth2 secrets were never shared with Alice, there is no risk Alice can reuse the OAuth2 secrets. On the other hand, the OAuth2 tokens assigned in step #4 must be invalidated because Alice had the OAuth2 tokens in her possession.

create_time str

The time when this managed object was created.

description str

Description of the application.

domain_group_moid str

The DomainGroup ID for this managed object.

entity_id str

EntityId holds the Id of the client application that is using this AppRegistration.

expiry_date_time str

The expiration date of the App Registration which is set at the time of its creation. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the App Registration to the maximum expiry time configured at the account level.

grant_types Sequence[str]

id str

is_never_expiring bool

Used to mark the App Registration as a never-expiring App Registration.

last_used_ip str

The ip address from which the App Registration was last used.

last_used_time str

The time at which the App Registration was last used. It is updated every 24 hours.

mod_time str

The time when this managed object was last modified.

moid str

The unique identifier of this Managed Object instance.

oauth_tokens Sequence[GetIamAppRegistrationOauthToken]

object_type str

oper_status str

The current status of the App Registration that dictates the validity of the app.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.

owners Sequence[str]

parent GetIamAppRegistrationParent

permission GetIamAppRegistrationPermission

permission_resources Sequence[GetIamAppRegistrationPermissionResource]

redirect_uris Sequence[str]

renew_client_secret bool

Set value to true to renew the client-secret. Applicable to client_credentials grant type.

response_types Sequence[str]

revocation_timestamp str

Used to perform revocation for tokens of AppRegistration.Updated only internally is case Revoke property come from UI with value true.On each request with OAuth2 access token the CreationTime of the OAuth2 token will be compared to RevokationTimestamp of thecorresponding App Registration.

revoke bool

Used to trigger update the revocationTimestamp value.If UI sent updating request with the Revoke value is true, then update RevocationTimestamp.

roles Sequence[GetIamAppRegistrationRole]

scope GetIamAppRegistrationScope

security_holder GetIamAppRegistrationSecurityHolder

shared_scope str

Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.

show_consent_screen bool

Set to true if consent screen needs to be shown during the OAuth login process.Applicable only for public AppRegistrations, means only 'authorization_code' grantType.Note that consent screen will be shown on each login.

start_time str

The timestamp at which an expiry date was first set on this app registration. For expiring App Registrations, this field is same as the create time of the App Registration.For never-expiring App Registrations, this field is set initially to zero time value. If a never-expiry App Registration is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.

tags Sequence[GetIamAppRegistrationTag]

token_expiry str

Defines the expiry time of the token generated via the AppRegistration.* generic - This sets the expiryTime to ten minutes from the token issuing time.* longLived - This sets the expiryTime to an year from the token issuing time.* infinite - This allows for a never-expiring token. Use with caution.

user GetIamAppRegistrationUser

version_context GetIamAppRegistrationVersionContext

account Property Map

accountMoid String

The Account ID for this managed object.

additionalProperties String

adminStatus String

Used to trigger the enable or disable action on the App Registration. These actions change the status of an App Registration.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.

ancestors List<Property Map>

classId String

clientApplication Property Map

clientId String

A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.

clientName String

App Registration name specified by user.

clientSecret String

The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.

clientType String

The type of the OAuth2 client (public or confidential), as specified in https://tools.ietf.org/html/rfc6749#section-2.1.* public - Clients incapable of maintaining the confidentiality of their credentials.This includes clients executing on the device used by the resource owner,such as mobile applications, installed native application or a webbrowser-based application.* confidential - Clients capable of maintaining the confidentiality of their credentials.For example, this could be a client implemented on a secure server withrestricted access to the client credentials.To maintain the confidentiality of the OAuth2 credentials, two use cases areconsidered.1) The application is running as a service within Intersight. The application automatically obtains the OAuth2 credentials when the application starts and the credentials are not exposed to the end-user. Because end-users (even account administrators) do not have access the OAuth2 credentials, they cannot take the credentials with them when they leave their organization.2) The application is under the control of a \ trusted\ end-user. For example, the end-user may create a native application running outside Intersight. The application uses OAuth2 credentials to interact with the Intersight API. In that case, the Intersight account administrator may generate OAuth2 credentials with a registered application using \ client_credentials\ grant type. In that case, the end-user is responsible for maintaining the confidentiality of the OAuth2 credentials. If the end-user leaves the organization, you should revoke the credentials and issue new Oauth2 credentials.Here is a possible workflow for handling OAuth2 tokens.1) User Alice (Intersight Account Administrator) logins to Intersight and deploys an Intersight application that requires an OAuth2 token.2) Intersight automatically deploys the application. The application is assigned a OAuth2 token, possibly linked to Alice. The application must NOT expose the OAuth2 secret to Alice, otherwise Alice would be able to use the token after she leaves the company.3) The application can make API calls to Intersight using its assigned OAuth2 token. For example, the application could make weekly scheduled API calls to Intersight.4) Separately, Alice may also get OAuth2 tokens that she can use to make API calls from the Intersight SDK through the northbound API. In that case, Alice will get the associated OAuth2 secrets, but not the one assigned in step #2.5) Alice leaves the organization. The OAuth2 tokens assigned in step #2 must retain their validity even after Alice has left the organization. Because the OAuth2 secrets were never shared with Alice, there is no risk Alice can reuse the OAuth2 secrets. On the other hand, the OAuth2 tokens assigned in step #4 must be invalidated because Alice had the OAuth2 tokens in her possession.

createTime String

The time when this managed object was created.

description String

Description of the application.

domainGroupMoid String

The DomainGroup ID for this managed object.

entityId String

EntityId holds the Id of the client application that is using this AppRegistration.

expiryDateTime String

The expiration date of the App Registration which is set at the time of its creation. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the App Registration to the maximum expiry time configured at the account level.

grantTypes List<String>

id String

isNeverExpiring Boolean

Used to mark the App Registration as a never-expiring App Registration.

lastUsedIp String

The ip address from which the App Registration was last used.

lastUsedTime String

The time at which the App Registration was last used. It is updated every 24 hours.

modTime String

The time when this managed object was last modified.

moid String

The unique identifier of this Managed Object instance.

oauthTokens List<Property Map>

objectType String

operStatus String

The current status of the App Registration that dictates the validity of the app.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.

owners List<String>

parent Property Map

permission Property Map

permissionResources List<Property Map>

redirectUris List<String>

renewClientSecret Boolean

Set value to true to renew the client-secret. Applicable to client_credentials grant type.

responseTypes List<String>

revocationTimestamp String

Used to perform revocation for tokens of AppRegistration.Updated only internally is case Revoke property come from UI with value true.On each request with OAuth2 access token the CreationTime of the OAuth2 token will be compared to RevokationTimestamp of thecorresponding App Registration.

revoke Boolean

Used to trigger update the revocationTimestamp value.If UI sent updating request with the Revoke value is true, then update RevocationTimestamp.

roles List<Property Map>

scope Property Map

securityHolder Property Map

sharedScope String

Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.

showConsentScreen Boolean

Set to true if consent screen needs to be shown during the OAuth login process.Applicable only for public AppRegistrations, means only 'authorization_code' grantType.Note that consent screen will be shown on each login.

startTime String

The timestamp at which an expiry date was first set on this app registration. For expiring App Registrations, this field is same as the create time of the App Registration.For never-expiring App Registrations, this field is set initially to zero time value. If a never-expiry App Registration is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.

tags List<Property Map>

tokenExpiry String

Defines the expiry time of the token generated via the AppRegistration.* generic - This sets the expiryTime to ten minutes from the token issuing time.* longLived - This sets the expiryTime to an year from the token issuing time.* infinite - This allows for a never-expiring token. Use with caution.

user Property Map

versionContext Property Map

Id string

Results List<GetIamAppRegistrationResult>

Account GetIamAppRegistrationAccount

AccountMoid string

AdditionalProperties string

AdminStatus string

Ancestors List<GetIamAppRegistrationAncestor>

ClassId string

ClientApplication GetIamAppRegistrationClientApplication

ClientId string

ClientName string

ClientSecret string

ClientType string

CreateTime string

Description string

DomainGroupMoid string

EntityId string

ExpiryDateTime string

GrantTypes List<string>

IsNeverExpiring bool

LastUsedIp string

LastUsedTime string

ModTime string

Moid string

OauthTokens List<GetIamAppRegistrationOauthToken>

ObjectType string

OperStatus string

Owners List<string>

Parent GetIamAppRegistrationParent

Permission GetIamAppRegistrationPermission

PermissionResources List<GetIamAppRegistrationPermissionResource>

RedirectUris List<string>

RenewClientSecret bool

ResponseTypes List<string>

RevocationTimestamp string

Revoke bool

Roles List<GetIamAppRegistrationRole>

Scope GetIamAppRegistrationScope

SecurityHolder GetIamAppRegistrationSecurityHolder

SharedScope string

ShowConsentScreen bool

StartTime string

Tags List<GetIamAppRegistrationTag>

TokenExpiry string

User GetIamAppRegistrationUser

VersionContext GetIamAppRegistrationVersionContext

Id string

Results []GetIamAppRegistrationResult

Account GetIamAppRegistrationAccount

AccountMoid string

AdditionalProperties string

AdminStatus string

Ancestors []GetIamAppRegistrationAncestor

ClassId string

ClientApplication GetIamAppRegistrationClientApplication

ClientId string

ClientName string

ClientSecret string

ClientType string

CreateTime string

Description string

DomainGroupMoid string

EntityId string

ExpiryDateTime string

GrantTypes []string

IsNeverExpiring bool

LastUsedIp string

LastUsedTime string

ModTime string

Moid string

OauthTokens []GetIamAppRegistrationOauthToken

ObjectType string

OperStatus string

Owners []string

Parent GetIamAppRegistrationParent

Permission GetIamAppRegistrationPermission

PermissionResources []GetIamAppRegistrationPermissionResource

RedirectUris []string

RenewClientSecret bool

ResponseTypes []string

RevocationTimestamp string

Revoke bool

Roles []GetIamAppRegistrationRole

Scope GetIamAppRegistrationScope

SecurityHolder GetIamAppRegistrationSecurityHolder

SharedScope string

ShowConsentScreen bool

StartTime string

Tags []GetIamAppRegistrationTag

TokenExpiry string

User GetIamAppRegistrationUser

VersionContext GetIamAppRegistrationVersionContext

id String

results List<GetIamAppRegistrationResult>

account GetIamAppRegistrationAccount

accountMoid String

additionalProperties String

adminStatus String

ancestors List<GetIamAppRegistrationAncestor>

classId String

clientApplication GetIamAppRegistrationClientApplication

clientId String

clientName String

clientSecret String

clientType String

createTime String

description String

domainGroupMoid String

entityId String

expiryDateTime String

grantTypes List<String>

isNeverExpiring Boolean

lastUsedIp String

lastUsedTime String

modTime String

moid String

oauthTokens List<GetIamAppRegistrationOauthToken>

objectType String

operStatus String

owners List<String>

parent GetIamAppRegistrationParent

permission GetIamAppRegistrationPermission

permissionResources List<GetIamAppRegistrationPermissionResource>

redirectUris List<String>

renewClientSecret Boolean

responseTypes List<String>

revocationTimestamp String

revoke Boolean

roles List<GetIamAppRegistrationRole>

scope GetIamAppRegistrationScope

securityHolder GetIamAppRegistrationSecurityHolder

sharedScope String

showConsentScreen Boolean

startTime String

tags List<GetIamAppRegistrationTag>

tokenExpiry String

user GetIamAppRegistrationUser

versionContext GetIamAppRegistrationVersionContext

id string

results GetIamAppRegistrationResult[]

account GetIamAppRegistrationAccount

accountMoid string

additionalProperties string

adminStatus string

ancestors GetIamAppRegistrationAncestor[]

classId string

clientApplication GetIamAppRegistrationClientApplication

clientId string

clientName string

clientSecret string

clientType string

createTime string

description string

domainGroupMoid string

entityId string

expiryDateTime string

grantTypes string[]

isNeverExpiring boolean

lastUsedIp string

lastUsedTime string

modTime string

moid string

oauthTokens GetIamAppRegistrationOauthToken[]

objectType string

operStatus string

owners string[]

parent GetIamAppRegistrationParent

permission GetIamAppRegistrationPermission

permissionResources GetIamAppRegistrationPermissionResource[]

redirectUris string[]

renewClientSecret boolean

responseTypes string[]

revocationTimestamp string

revoke boolean

roles GetIamAppRegistrationRole[]

scope GetIamAppRegistrationScope

securityHolder GetIamAppRegistrationSecurityHolder

sharedScope string

showConsentScreen boolean

startTime string

tags GetIamAppRegistrationTag[]

tokenExpiry string

user GetIamAppRegistrationUser

versionContext GetIamAppRegistrationVersionContext

id str

results Sequence[GetIamAppRegistrationResult]

account GetIamAppRegistrationAccount

account_moid str

additional_properties str

admin_status str

ancestors Sequence[GetIamAppRegistrationAncestor]

class_id str

client_application GetIamAppRegistrationClientApplication

client_id str

client_name str

client_secret str

client_type str

create_time str

description str

domain_group_moid str

entity_id str

expiry_date_time str

grant_types Sequence[str]

is_never_expiring bool

last_used_ip str

last_used_time str

mod_time str

moid str

oauth_tokens Sequence[GetIamAppRegistrationOauthToken]

object_type str

oper_status str

owners Sequence[str]

parent GetIamAppRegistrationParent

permission GetIamAppRegistrationPermission

permission_resources Sequence[GetIamAppRegistrationPermissionResource]

redirect_uris Sequence[str]

renew_client_secret bool

response_types Sequence[str]

revocation_timestamp str

revoke bool

roles Sequence[GetIamAppRegistrationRole]

scope GetIamAppRegistrationScope

security_holder GetIamAppRegistrationSecurityHolder

shared_scope str

show_consent_screen bool

start_time str

tags Sequence[GetIamAppRegistrationTag]

token_expiry str

user GetIamAppRegistrationUser

version_context GetIamAppRegistrationVersionContext

id String

results List<Property Map>

account Property Map

accountMoid String

additionalProperties String

adminStatus String

ancestors List<Property Map>

classId String

clientApplication Property Map

clientId String

clientName String

clientSecret String

clientType String

createTime String

description String

domainGroupMoid String

entityId String

expiryDateTime String

grantTypes List<String>

isNeverExpiring Boolean

lastUsedIp String

lastUsedTime String

modTime String

moid String

oauthTokens List<Property Map>

objectType String

operStatus String

owners List<String>

parent Property Map

permission Property Map

permissionResources List<Property Map>

redirectUris List<String>

renewClientSecret Boolean

responseTypes List<String>

revocationTimestamp String

revoke Boolean

roles List<Property Map>

scope Property Map

securityHolder Property Map

sharedScope String

showConsentScreen Boolean

startTime String

tags List<Property Map>

tokenExpiry String

user Property Map

versionContext Property Map

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string

classId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid string

The unique identifier of this Managed Object instance.

objectType string

The fully-qualified name of the remote type referred by this relationship.

selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str

class_id str

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid str

The unique identifier of this Managed Object instance.

object_type str

The fully-qualified name of the remote type referred by this relationship.

selector str

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string

classId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid string

The unique identifier of this Managed Object instance.

objectType string

The fully-qualified name of the remote type referred by this relationship.

selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str

class_id str

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid str

The unique identifier of this Managed Object instance.

object_type str

The fully-qualified name of the remote type referred by this relationship.

selector str

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string

classId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid string

The unique identifier of this Managed Object instance.

objectType string

The fully-qualified name of the remote type referred by this relationship.

selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str

class_id str

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid str

The unique identifier of this Managed Object instance.

object_type str

The fully-qualified name of the remote type referred by this relationship.

selector str

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string

classId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid string

The unique identifier of this Managed Object instance.

objectType string

The fully-qualified name of the remote type referred by this relationship.

selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str

class_id str

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid str

The unique identifier of this Managed Object instance.

object_type str

The fully-qualified name of the remote type referred by this relationship.

selector str

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string

classId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid string

The unique identifier of this Managed Object instance.

objectType string

The fully-qualified name of the remote type referred by this relationship.

selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str

class_id str

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid str

The unique identifier of this Managed Object instance.

object_type str

The fully-qualified name of the remote type referred by this relationship.

selector str

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string

classId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid string

The unique identifier of this Managed Object instance.

objectType string

The fully-qualified name of the remote type referred by this relationship.

selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str

class_id str

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid str

The unique identifier of this Managed Object instance.

object_type str

The fully-qualified name of the remote type referred by this relationship.

selector str

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AdditionalProperties string

ClassId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

Moid string

The unique identifier of this Managed Object instance.

ObjectType string

The fully-qualified name of the remote type referred by this relationship.

Selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties string

classId string

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid string

The unique identifier of this Managed Object instance.

objectType string

The fully-qualified name of the remote type referred by this relationship.

selector string

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additional_properties str

class_id str

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid str

The unique identifier of this Managed Object instance.

object_type str

The fully-qualified name of the remote type referred by this relationship.

selector str

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

additionalProperties String

classId String

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.

moid String

The unique identifier of this Managed Object instance.

objectType String

The fully-qualified name of the remote type referred by this relationship.

selector String

An OData $filter expression which describes the REST resource to be referenced. This field may be set instead of 'moid' by clients.

1. If 'moid' is set this field is ignored.
2. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the resource matching the filter expression and populates it in the MoRef that is part of the object instance being inserted/updated to fulfill the REST request. An error is returned if the filter matches zero or more than one REST resource. An example filter string is: Serial eq '3AA8B7T11'.

AccountMoid string

The Account ID for this managed object.

Accounts List<GetIamAppRegistrationResultAccount>

AdditionalProperties string

AdminStatus string

Used to trigger the enable or disable action on the App Registration. These actions change the status of an App Registration.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.

Ancestors List<GetIamAppRegistrationResultAncestor>

ClassId string

ClientApplications List<GetIamAppRegistrationResultClientApplication>

ClientId string

A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.

ClientName string

App Registration name specified by user.

ClientSecret string

The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.

ClientType string

The type of the OAuth2 client (public or confidential), as specified in https://tools.ietf.org/html/rfc6749#section-2.1.* public - Clients incapable of maintaining the confidentiality of their credentials.This includes clients executing on the device used by the resource owner,such as mobile applications, installed native application or a webbrowser-based application.* confidential - Clients capable of maintaining the confidentiality of their credentials.For example, this could be a client implemented on a secure server withrestricted access to the client credentials.To maintain the confidentiality of the OAuth2 credentials, two use cases areconsidered.1) The application is running as a service within Intersight. The application automatically obtains the OAuth2 credentials when the application starts and the credentials are not exposed to the end-user. Because end-users (even account administrators) do not have access the OAuth2 credentials, they cannot take the credentials with them when they leave their organization.2) The application is under the control of a \ trusted\ end-user. For example, the end-user may create a native application running outside Intersight. The application uses OAuth2 credentials to interact with the Intersight API. In that case, the Intersight account administrator may generate OAuth2 credentials with a registered application using \ client_credentials\ grant type. In that case, the end-user is responsible for maintaining the confidentiality of the OAuth2 credentials. If the end-user leaves the organization, you should revoke the credentials and issue new Oauth2 credentials.Here is a possible workflow for handling OAuth2 tokens.1) User Alice (Intersight Account Administrator) logins to Intersight and deploys an Intersight application that requires an OAuth2 token.2) Intersight automatically deploys the application. The application is assigned a OAuth2 token, possibly linked to Alice. The application must NOT expose the OAuth2 secret to Alice, otherwise Alice would be able to use the token after she leaves the company.3) The application can make API calls to Intersight using its assigned OAuth2 token. For example, the application could make weekly scheduled API calls to Intersight.4) Separately, Alice may also get OAuth2 tokens that she can use to make API calls from the Intersight SDK through the northbound API. In that case, Alice will get the associated OAuth2 secrets, but not the one assigned in step #2.5) Alice leaves the organization. The OAuth2 tokens assigned in step #2 must retain their validity even after Alice has left the organization. Because the OAuth2 secrets were never shared with Alice, there is no risk Alice can reuse the OAuth2 secrets. On the other hand, the OAuth2 tokens assigned in step #4 must be invalidated because Alice had the OAuth2 tokens in her possession.

CreateTime string

The time when this managed object was created.

Description string

Description of the application.

DomainGroupMoid string

The DomainGroup ID for this managed object.

EntityId string

EntityId holds the Id of the client application that is using this AppRegistration.

ExpiryDateTime string

The expiration date of the App Registration which is set at the time of its creation. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the App Registration to the maximum expiry time configured at the account level.

GrantTypes List<string>

IsNeverExpiring bool

Used to mark the App Registration as a never-expiring App Registration.

LastUsedIp string

The ip address from which the App Registration was last used.

LastUsedTime string

The time at which the App Registration was last used. It is updated every 24 hours.

ModTime string

The time when this managed object was last modified.

Moid string

The unique identifier of this Managed Object instance.

OauthTokens List<GetIamAppRegistrationResultOauthToken>

ObjectType string

OperStatus string

The current status of the App Registration that dictates the validity of the app.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.

Owners List<string>

Parents List<GetIamAppRegistrationResultParent>

PermissionResources List<GetIamAppRegistrationResultPermissionResource>

Permissions List<GetIamAppRegistrationResultPermission>

RedirectUris List<string>

RenewClientSecret bool

Set value to true to renew the client-secret. Applicable to client_credentials grant type.

ResponseTypes List<string>

RevocationTimestamp string

Used to perform revocation for tokens of AppRegistration.Updated only internally is case Revoke property come from UI with value true.On each request with OAuth2 access token the CreationTime of the OAuth2 token will be compared to RevokationTimestamp of thecorresponding App Registration.

Revoke bool

Used to trigger update the revocationTimestamp value.If UI sent updating request with the Revoke value is true, then update RevocationTimestamp.

Roles List<GetIamAppRegistrationResultRole>

Scopes List<GetIamAppRegistrationResultScope>

SecurityHolders List<GetIamAppRegistrationResultSecurityHolder>

SharedScope string

Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.

ShowConsentScreen bool

Set to true if consent screen needs to be shown during the OAuth login process.Applicable only for public AppRegistrations, means only 'authorization_code' grantType.Note that consent screen will be shown on each login.

StartTime string

The timestamp at which an expiry date was first set on this app registration. For expiring App Registrations, this field is same as the create time of the App Registration.For never-expiring App Registrations, this field is set initially to zero time value. If a never-expiry App Registration is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.

Tags List<GetIamAppRegistrationResultTag>

TokenExpiry string

Defines the expiry time of the token generated via the AppRegistration.* generic - This sets the expiryTime to ten minutes from the token issuing time.* longLived - This sets the expiryTime to an year from the token issuing time.* infinite - This allows for a never-expiring token. Use with caution.

Users List<GetIamAppRegistrationResultUser>

VersionContexts List<GetIamAppRegistrationResultVersionContext>

AccountMoid string

The Account ID for this managed object.

Accounts []GetIamAppRegistrationResultAccount

AdditionalProperties string

AdminStatus string

Used to trigger the enable or disable action on the App Registration. These actions change the status of an App Registration.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.

Ancestors []GetIamAppRegistrationResultAncestor

ClassId string

ClientApplications []GetIamAppRegistrationResultClientApplication

ClientId string

A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.

ClientName string

App Registration name specified by user.

ClientSecret string

The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.

ClientType string

The type of the OAuth2 client (public or confidential), as specified in https://tools.ietf.org/html/rfc6749#section-2.1.* public - Clients incapable of maintaining the confidentiality of their credentials.This includes clients executing on the device used by the resource owner,such as mobile applications, installed native application or a webbrowser-based application.* confidential - Clients capable of maintaining the confidentiality of their credentials.For example, this could be a client implemented on a secure server withrestricted access to the client credentials.To maintain the confidentiality of the OAuth2 credentials, two use cases areconsidered.1) The application is running as a service within Intersight. The application automatically obtains the OAuth2 credentials when the application starts and the credentials are not exposed to the end-user. Because end-users (even account administrators) do not have access the OAuth2 credentials, they cannot take the credentials with them when they leave their organization.2) The application is under the control of a \ trusted\ end-user. For example, the end-user may create a native application running outside Intersight. The application uses OAuth2 credentials to interact with the Intersight API. In that case, the Intersight account administrator may generate OAuth2 credentials with a registered application using \ client_credentials\ grant type. In that case, the end-user is responsible for maintaining the confidentiality of the OAuth2 credentials. If the end-user leaves the organization, you should revoke the credentials and issue new Oauth2 credentials.Here is a possible workflow for handling OAuth2 tokens.1) User Alice (Intersight Account Administrator) logins to Intersight and deploys an Intersight application that requires an OAuth2 token.2) Intersight automatically deploys the application. The application is assigned a OAuth2 token, possibly linked to Alice. The application must NOT expose the OAuth2 secret to Alice, otherwise Alice would be able to use the token after she leaves the company.3) The application can make API calls to Intersight using its assigned OAuth2 token. For example, the application could make weekly scheduled API calls to Intersight.4) Separately, Alice may also get OAuth2 tokens that she can use to make API calls from the Intersight SDK through the northbound API. In that case, Alice will get the associated OAuth2 secrets, but not the one assigned in step #2.5) Alice leaves the organization. The OAuth2 tokens assigned in step #2 must retain their validity even after Alice has left the organization. Because the OAuth2 secrets were never shared with Alice, there is no risk Alice can reuse the OAuth2 secrets. On the other hand, the OAuth2 tokens assigned in step #4 must be invalidated because Alice had the OAuth2 tokens in her possession.

CreateTime string

The time when this managed object was created.

Description string

Description of the application.

DomainGroupMoid string

The DomainGroup ID for this managed object.

EntityId string

EntityId holds the Id of the client application that is using this AppRegistration.

ExpiryDateTime string

The expiration date of the App Registration which is set at the time of its creation. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the App Registration to the maximum expiry time configured at the account level.

GrantTypes []string

IsNeverExpiring bool

Used to mark the App Registration as a never-expiring App Registration.

LastUsedIp string

The ip address from which the App Registration was last used.

LastUsedTime string

The time at which the App Registration was last used. It is updated every 24 hours.

ModTime string

The time when this managed object was last modified.

Moid string

The unique identifier of this Managed Object instance.

OauthTokens []GetIamAppRegistrationResultOauthToken

ObjectType string

OperStatus string

The current status of the App Registration that dictates the validity of the app.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.

Owners []string

Parents []GetIamAppRegistrationResultParent

PermissionResources []GetIamAppRegistrationResultPermissionResource

Permissions []GetIamAppRegistrationResultPermission

RedirectUris []string

RenewClientSecret bool

Set value to true to renew the client-secret. Applicable to client_credentials grant type.

ResponseTypes []string

RevocationTimestamp string

Used to perform revocation for tokens of AppRegistration.Updated only internally is case Revoke property come from UI with value true.On each request with OAuth2 access token the CreationTime of the OAuth2 token will be compared to RevokationTimestamp of thecorresponding App Registration.

Revoke bool

Used to trigger update the revocationTimestamp value.If UI sent updating request with the Revoke value is true, then update RevocationTimestamp.

Roles []GetIamAppRegistrationResultRole

Scopes []GetIamAppRegistrationResultScope

SecurityHolders []GetIamAppRegistrationResultSecurityHolder

SharedScope string

Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.

ShowConsentScreen bool

Set to true if consent screen needs to be shown during the OAuth login process.Applicable only for public AppRegistrations, means only 'authorization_code' grantType.Note that consent screen will be shown on each login.

StartTime string

The timestamp at which an expiry date was first set on this app registration. For expiring App Registrations, this field is same as the create time of the App Registration.For never-expiring App Registrations, this field is set initially to zero time value. If a never-expiry App Registration is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.

Tags []GetIamAppRegistrationResultTag

TokenExpiry string

Defines the expiry time of the token generated via the AppRegistration.* generic - This sets the expiryTime to ten minutes from the token issuing time.* longLived - This sets the expiryTime to an year from the token issuing time.* infinite - This allows for a never-expiring token. Use with caution.

Users []GetIamAppRegistrationResultUser

VersionContexts []GetIamAppRegistrationResultVersionContext

accountMoid String

The Account ID for this managed object.

accounts List<GetIamAppRegistrationResultAccount>

additionalProperties String

adminStatus String

Used to trigger the enable or disable action on the App Registration. These actions change the status of an App Registration.* enable - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.* disable - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.

ancestors List<GetIamAppRegistrationResultAncestor>

classId String

clientApplications List<GetIamAppRegistrationResultClientApplication>

clientId String

A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.

clientName String

App Registration name specified by user.

clientSecret String

The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.

clientType String

The type of the OAuth2 client (public or confidential), as specified in https://tools.ietf.org/html/rfc6749#section-2.1.* public - Clients incapable of maintaining the confidentiality of their credentials.This includes clients executing on the device used by the resource owner,such as mobile applications, installed native application or a webbrowser-based application.* confidential - Clients capable of maintaining the confidentiality of their credentials.For example, this could be a client implemented on a secure server withrestricted access to the client credentials.To maintain the confidentiality of the OAuth2 credentials, two use cases areconsidered.1) The application is running as a service within Intersight. The application automatically obtains the OAuth2 credentials when the application starts and the credentials are not exposed to the end-user. Because end-users (even account administrators) do not have access the OAuth2 credentials, they cannot take the credentials with them when they leave their organization.2) The application is under the control of a \ trusted\ end-user. For example, the end-user may create a native application running outside Intersight. The application uses OAuth2 credentials to interact with the Intersight API. In that case, the Intersight account administrator may generate OAuth2 credentials with a registered application using \ client_credentials\ grant type. In that case, the end-user is responsible for maintaining the confidentiality of the OAuth2 credentials. If the end-user leaves the organization, you should revoke the credentials and issue new Oauth2 credentials.Here is a possible workflow for handling OAuth2 tokens.1) User Alice (Intersight Account Administrator) logins to Intersight and deploys an Intersight application that requires an OAuth2 token.2) Intersight automatically deploys the application. The application is assigned a OAuth2 token, possibly linked to Alice. The application must NOT expose the OAuth2 secret to Alice, otherwise Alice would be able to use the token after she leaves the company.3) The application can make API calls to Intersight using its assigned OAuth2 token. For example, the application could make weekly scheduled API calls to Intersight.4) Separately, Alice may also get OAuth2 tokens that she can use to make API calls from the Intersight SDK through the northbound API. In that case, Alice will get the associated OAuth2 secrets, but not the one assigned in step #2.5) Alice leaves the organization. The OAuth2 tokens assigned in step #2 must retain their validity even after Alice has left the organization. Because the OAuth2 secrets were never shared with Alice, there is no risk Alice can reuse the OAuth2 secrets. On the other hand, the OAuth2 tokens assigned in step #4 must be invalidated because Alice had the OAuth2 tokens in her possession.

createTime String

The time when this managed object was created.

description String

Description of the application.

domainGroupMoid String

The DomainGroup ID for this managed object.

entityId String

EntityId holds the Id of the client application that is using this AppRegistration.

expiryDateTime String

The expiration date of the App Registration which is set at the time of its creation. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the App Registration to the maximum expiry time configured at the account level.

grantTypes List<String>

isNeverExpiring Boolean

Used to mark the App Registration as a never-expiring App Registration.

lastUsedIp String

The ip address from which the App Registration was last used.

lastUsedTime String

The time at which the App Registration was last used. It is updated every 24 hours.

modTime String

The time when this managed object was last modified.

moid String

The unique identifier of this Managed Object instance.

oauthTokens List<GetIamAppRegistrationResultOauthToken>

objectType String

operStatus String

The current status of the App Registration that dictates the validity of the app.* enabled - An API key/App Registration having enabled status can be used for API invocation.* disabled - An API key/App Registration having disabled status cannot be used for API invocation.* expired - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.

owners List<String>

parents List<GetIamAppRegistrationResultParent>

permissionResources List<GetIamAppRegistrationResultPermissionResource>

permissions List<GetIamAppRegistrationResultPermission>

redirectUris List<String>

renewClientSecret Boolean

Set value to true to renew the client-secret. Applicable to client_credentials grant type.

responseTypes List<String>

revocationTimestamp String

Used to perform revocation for tokens of AppRegistration.Updated only internally is case Revoke property come from UI with value true.On each request with OAuth2 access token the CreationTime of the OAuth2 token will be compared to RevokationTimestamp of thecorresponding App Registration.

revoke Boolean

Used to trigger update the revocationTimestamp value.If UI sent updating request with the Revoke value is true, then update RevocationTimestamp.

roles List<GetIamAppRegistrationResultRole>

scopes List<GetIamAppRegistrationResultScope>

securityHolders List<GetIamAppRegistrationResultSecurityHolder>

sharedScope String

Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.Objects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.

showConsentScreen Boolean

Set to true if consent screen needs to be shown during the OAuth login process.Applicable only for public AppRegistrations, means only 'authorization_code' grantType.Note that consent screen will be shown on each login.

startTime String

The timestamp at which an expiry date was first set on this app registration. For expiring App Registrations, this field is same as the create time of the App Registration.For never-expiring App Registrations, this field is set initially to zero time value. If a never-expiry App Registration is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.

tags List<GetIamAppRegistrationResultTag>

tokenExpiry String

Defines the expiry time of the token generated via the AppRegistration.* generic - This sets the expiryTime to ten minutes from the token issuing time.* longLived - This sets the expiryTime to an year from the token issuing time.* infinite - This allows for a never-expiring token. Use with caution.

users List<GetIamAppRegistrationResultUser>

versionContexts List<GetIamAppRegistrationResultVersionContext>