intersight.IamAppRegistration
Explore with Pulumi AI
AppRegistration encapsulates the meta-data values of a registered OAuth2 client application, as described in https://tools.ietf.org/html/rfc7591#section-2. Registered client applications have a set of metadata values associated with their client identifier at the Intersight authorization server, including the list of valid redirection URIs or a display name. The meta-data is used to specify how a client application can retrieve a OAuth2 Access Token and subsequently invoke Intersight API on behalf of this AppRegistration. To register an OAuth2 application, the following information must be provided.
- Application name
- An icon for the application
- URL to the application’s home page
- A short description of the application
- A list of redirect URLs When an AppRegistration is created, a unique OAuth2 clientId is generated and returned in the HTTP response.
Create IamAppRegistration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IamAppRegistration(name: string, args?: IamAppRegistrationArgs, opts?: CustomResourceOptions);
@overload
def IamAppRegistration(resource_name: str,
args: Optional[IamAppRegistrationArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def IamAppRegistration(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_moid: Optional[str] = None,
accounts: Optional[Sequence[IamAppRegistrationAccountArgs]] = None,
additional_properties: Optional[str] = None,
admin_status: Optional[str] = None,
ancestors: Optional[Sequence[IamAppRegistrationAncestorArgs]] = None,
class_id: Optional[str] = None,
client_applications: Optional[Sequence[IamAppRegistrationClientApplicationArgs]] = None,
client_id: Optional[str] = None,
client_name: Optional[str] = None,
client_secret: Optional[str] = None,
client_type: Optional[str] = None,
create_time: Optional[str] = None,
description: Optional[str] = None,
domain_group_moid: Optional[str] = None,
entity_id: Optional[str] = None,
expiry_date_time: Optional[str] = None,
grant_types: Optional[Sequence[str]] = None,
iam_app_registration_id: Optional[str] = None,
is_never_expiring: Optional[bool] = None,
last_used_ip: Optional[str] = None,
last_used_time: Optional[str] = None,
mod_time: Optional[str] = None,
moid: Optional[str] = None,
oauth_tokens: Optional[Sequence[IamAppRegistrationOauthTokenArgs]] = None,
object_type: Optional[str] = None,
oper_status: Optional[str] = None,
owners: Optional[Sequence[str]] = None,
parents: Optional[Sequence[IamAppRegistrationParentArgs]] = None,
permission_resources: Optional[Sequence[IamAppRegistrationPermissionResourceArgs]] = None,
permissions: Optional[Sequence[IamAppRegistrationPermissionArgs]] = None,
redirect_uris: Optional[Sequence[str]] = None,
renew_client_secret: Optional[bool] = None,
response_types: Optional[Sequence[str]] = None,
revocation_timestamp: Optional[str] = None,
revoke: Optional[bool] = None,
roles: Optional[Sequence[IamAppRegistrationRoleArgs]] = None,
scopes: Optional[Sequence[IamAppRegistrationScopeArgs]] = None,
security_holders: Optional[Sequence[IamAppRegistrationSecurityHolderArgs]] = None,
shared_scope: Optional[str] = None,
show_consent_screen: Optional[bool] = None,
start_time: Optional[str] = None,
tags: Optional[Sequence[IamAppRegistrationTagArgs]] = None,
token_expiry: Optional[str] = None,
users: Optional[Sequence[IamAppRegistrationUserArgs]] = None,
version_contexts: Optional[Sequence[IamAppRegistrationVersionContextArgs]] = None)
func NewIamAppRegistration(ctx *Context, name string, args *IamAppRegistrationArgs, opts ...ResourceOption) (*IamAppRegistration, error)
public IamAppRegistration(string name, IamAppRegistrationArgs? args = null, CustomResourceOptions? opts = null)
public IamAppRegistration(String name, IamAppRegistrationArgs args)
public IamAppRegistration(String name, IamAppRegistrationArgs args, CustomResourceOptions options)
type: intersight:IamAppRegistration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args IamAppRegistrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args IamAppRegistrationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args IamAppRegistrationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IamAppRegistrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IamAppRegistrationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var iamAppRegistrationResource = new Intersight.IamAppRegistration("iamAppRegistrationResource", new()
{
AccountMoid = "string",
Accounts = new[]
{
new Intersight.Inputs.IamAppRegistrationAccountArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
AdditionalProperties = "string",
AdminStatus = "string",
Ancestors = new[]
{
new Intersight.Inputs.IamAppRegistrationAncestorArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
ClassId = "string",
ClientApplications = new[]
{
new Intersight.Inputs.IamAppRegistrationClientApplicationArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
ClientId = "string",
ClientName = "string",
ClientSecret = "string",
ClientType = "string",
CreateTime = "string",
Description = "string",
DomainGroupMoid = "string",
EntityId = "string",
ExpiryDateTime = "string",
GrantTypes = new[]
{
"string",
},
IamAppRegistrationId = "string",
IsNeverExpiring = false,
LastUsedIp = "string",
LastUsedTime = "string",
ModTime = "string",
Moid = "string",
OauthTokens = new[]
{
new Intersight.Inputs.IamAppRegistrationOauthTokenArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
ObjectType = "string",
OperStatus = "string",
Owners = new[]
{
"string",
},
Parents = new[]
{
new Intersight.Inputs.IamAppRegistrationParentArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
PermissionResources = new[]
{
new Intersight.Inputs.IamAppRegistrationPermissionResourceArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
Permissions = new[]
{
new Intersight.Inputs.IamAppRegistrationPermissionArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
RedirectUris = new[]
{
"string",
},
RenewClientSecret = false,
ResponseTypes = new[]
{
"string",
},
RevocationTimestamp = "string",
Revoke = false,
Roles = new[]
{
new Intersight.Inputs.IamAppRegistrationRoleArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
Scopes = new[]
{
new Intersight.Inputs.IamAppRegistrationScopeArgs
{
AccountAccessControlId = "string",
AdditionalProperties = "string",
ClassId = "string",
ObjectType = "string",
RequestIdentifier = "string",
SwitchedFromAccounts = new[]
{
new Intersight.Inputs.IamAppRegistrationScopeSwitchedFromAccountArgs
{
AccountId = "string",
AdditionalProperties = "string",
ClassId = "string",
ObjectType = "string",
PermissionId = "string",
},
},
SwitchedToAccounts = new[]
{
new Intersight.Inputs.IamAppRegistrationScopeSwitchedToAccountArgs
{
AccountId = "string",
AdditionalProperties = "string",
ClassId = "string",
ObjectType = "string",
PermissionId = "string",
},
},
},
},
SecurityHolders = new[]
{
new Intersight.Inputs.IamAppRegistrationSecurityHolderArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
SharedScope = "string",
ShowConsentScreen = false,
StartTime = "string",
Tags = new[]
{
new Intersight.Inputs.IamAppRegistrationTagArgs
{
AdditionalProperties = "string",
Key = "string",
Value = "string",
},
},
TokenExpiry = "string",
Users = new[]
{
new Intersight.Inputs.IamAppRegistrationUserArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
VersionContexts = new[]
{
new Intersight.Inputs.IamAppRegistrationVersionContextArgs
{
AdditionalProperties = "string",
ClassId = "string",
InterestedMos = new[]
{
new Intersight.Inputs.IamAppRegistrationVersionContextInterestedMoArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
MarkedForDeletion = false,
NrVersion = "string",
ObjectType = "string",
RefMos = new[]
{
new Intersight.Inputs.IamAppRegistrationVersionContextRefMoArgs
{
AdditionalProperties = "string",
ClassId = "string",
Moid = "string",
ObjectType = "string",
Selector = "string",
},
},
Timestamp = "string",
VersionType = "string",
},
},
});
example, err := intersight.NewIamAppRegistration(ctx, "iamAppRegistrationResource", &intersight.IamAppRegistrationArgs{
AccountMoid: pulumi.String("string"),
Accounts: intersight.IamAppRegistrationAccountArray{
&intersight.IamAppRegistrationAccountArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
AdditionalProperties: pulumi.String("string"),
AdminStatus: pulumi.String("string"),
Ancestors: intersight.IamAppRegistrationAncestorArray{
&intersight.IamAppRegistrationAncestorArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
ClassId: pulumi.String("string"),
ClientApplications: intersight.IamAppRegistrationClientApplicationArray{
&intersight.IamAppRegistrationClientApplicationArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
ClientId: pulumi.String("string"),
ClientName: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ClientType: pulumi.String("string"),
CreateTime: pulumi.String("string"),
Description: pulumi.String("string"),
DomainGroupMoid: pulumi.String("string"),
EntityId: pulumi.String("string"),
ExpiryDateTime: pulumi.String("string"),
GrantTypes: pulumi.StringArray{
pulumi.String("string"),
},
IamAppRegistrationId: pulumi.String("string"),
IsNeverExpiring: pulumi.Bool(false),
LastUsedIp: pulumi.String("string"),
LastUsedTime: pulumi.String("string"),
ModTime: pulumi.String("string"),
Moid: pulumi.String("string"),
OauthTokens: intersight.IamAppRegistrationOauthTokenArray{
&intersight.IamAppRegistrationOauthTokenArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
ObjectType: pulumi.String("string"),
OperStatus: pulumi.String("string"),
Owners: pulumi.StringArray{
pulumi.String("string"),
},
Parents: intersight.IamAppRegistrationParentArray{
&intersight.IamAppRegistrationParentArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
PermissionResources: intersight.IamAppRegistrationPermissionResourceArray{
&intersight.IamAppRegistrationPermissionResourceArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
Permissions: intersight.IamAppRegistrationPermissionArray{
&intersight.IamAppRegistrationPermissionArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
RedirectUris: pulumi.StringArray{
pulumi.String("string"),
},
RenewClientSecret: pulumi.Bool(false),
ResponseTypes: pulumi.StringArray{
pulumi.String("string"),
},
RevocationTimestamp: pulumi.String("string"),
Revoke: pulumi.Bool(false),
Roles: intersight.IamAppRegistrationRoleArray{
&intersight.IamAppRegistrationRoleArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
Scopes: intersight.IamAppRegistrationScopeArray{
&intersight.IamAppRegistrationScopeArgs{
AccountAccessControlId: pulumi.String("string"),
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
ObjectType: pulumi.String("string"),
RequestIdentifier: pulumi.String("string"),
SwitchedFromAccounts: intersight.IamAppRegistrationScopeSwitchedFromAccountArray{
&intersight.IamAppRegistrationScopeSwitchedFromAccountArgs{
AccountId: pulumi.String("string"),
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
ObjectType: pulumi.String("string"),
PermissionId: pulumi.String("string"),
},
},
SwitchedToAccounts: intersight.IamAppRegistrationScopeSwitchedToAccountArray{
&intersight.IamAppRegistrationScopeSwitchedToAccountArgs{
AccountId: pulumi.String("string"),
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
ObjectType: pulumi.String("string"),
PermissionId: pulumi.String("string"),
},
},
},
},
SecurityHolders: intersight.IamAppRegistrationSecurityHolderArray{
&intersight.IamAppRegistrationSecurityHolderArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
SharedScope: pulumi.String("string"),
ShowConsentScreen: pulumi.Bool(false),
StartTime: pulumi.String("string"),
Tags: intersight.IamAppRegistrationTagArray{
&intersight.IamAppRegistrationTagArgs{
AdditionalProperties: pulumi.String("string"),
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TokenExpiry: pulumi.String("string"),
Users: intersight.IamAppRegistrationUserArray{
&intersight.IamAppRegistrationUserArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
VersionContexts: intersight.IamAppRegistrationVersionContextArray{
&intersight.IamAppRegistrationVersionContextArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
InterestedMos: intersight.IamAppRegistrationVersionContextInterestedMoArray{
&intersight.IamAppRegistrationVersionContextInterestedMoArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
MarkedForDeletion: pulumi.Bool(false),
NrVersion: pulumi.String("string"),
ObjectType: pulumi.String("string"),
RefMos: intersight.IamAppRegistrationVersionContextRefMoArray{
&intersight.IamAppRegistrationVersionContextRefMoArgs{
AdditionalProperties: pulumi.String("string"),
ClassId: pulumi.String("string"),
Moid: pulumi.String("string"),
ObjectType: pulumi.String("string"),
Selector: pulumi.String("string"),
},
},
Timestamp: pulumi.String("string"),
VersionType: pulumi.String("string"),
},
},
})
var iamAppRegistrationResource = new IamAppRegistration("iamAppRegistrationResource", IamAppRegistrationArgs.builder()
.accountMoid("string")
.accounts(IamAppRegistrationAccountArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.additionalProperties("string")
.adminStatus("string")
.ancestors(IamAppRegistrationAncestorArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.classId("string")
.clientApplications(IamAppRegistrationClientApplicationArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.clientId("string")
.clientName("string")
.clientSecret("string")
.clientType("string")
.createTime("string")
.description("string")
.domainGroupMoid("string")
.entityId("string")
.expiryDateTime("string")
.grantTypes("string")
.iamAppRegistrationId("string")
.isNeverExpiring(false)
.lastUsedIp("string")
.lastUsedTime("string")
.modTime("string")
.moid("string")
.oauthTokens(IamAppRegistrationOauthTokenArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.objectType("string")
.operStatus("string")
.owners("string")
.parents(IamAppRegistrationParentArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.permissionResources(IamAppRegistrationPermissionResourceArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.permissions(IamAppRegistrationPermissionArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.redirectUris("string")
.renewClientSecret(false)
.responseTypes("string")
.revocationTimestamp("string")
.revoke(false)
.roles(IamAppRegistrationRoleArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.scopes(IamAppRegistrationScopeArgs.builder()
.accountAccessControlId("string")
.additionalProperties("string")
.classId("string")
.objectType("string")
.requestIdentifier("string")
.switchedFromAccounts(IamAppRegistrationScopeSwitchedFromAccountArgs.builder()
.accountId("string")
.additionalProperties("string")
.classId("string")
.objectType("string")
.permissionId("string")
.build())
.switchedToAccounts(IamAppRegistrationScopeSwitchedToAccountArgs.builder()
.accountId("string")
.additionalProperties("string")
.classId("string")
.objectType("string")
.permissionId("string")
.build())
.build())
.securityHolders(IamAppRegistrationSecurityHolderArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.sharedScope("string")
.showConsentScreen(false)
.startTime("string")
.tags(IamAppRegistrationTagArgs.builder()
.additionalProperties("string")
.key("string")
.value("string")
.build())
.tokenExpiry("string")
.users(IamAppRegistrationUserArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.versionContexts(IamAppRegistrationVersionContextArgs.builder()
.additionalProperties("string")
.classId("string")
.interestedMos(IamAppRegistrationVersionContextInterestedMoArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.markedForDeletion(false)
.nrVersion("string")
.objectType("string")
.refMos(IamAppRegistrationVersionContextRefMoArgs.builder()
.additionalProperties("string")
.classId("string")
.moid("string")
.objectType("string")
.selector("string")
.build())
.timestamp("string")
.versionType("string")
.build())
.build());
iam_app_registration_resource = intersight.IamAppRegistration("iamAppRegistrationResource",
account_moid="string",
accounts=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
additional_properties="string",
admin_status="string",
ancestors=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
class_id="string",
client_applications=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
client_id="string",
client_name="string",
client_secret="string",
client_type="string",
create_time="string",
description="string",
domain_group_moid="string",
entity_id="string",
expiry_date_time="string",
grant_types=["string"],
iam_app_registration_id="string",
is_never_expiring=False,
last_used_ip="string",
last_used_time="string",
mod_time="string",
moid="string",
oauth_tokens=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
object_type="string",
oper_status="string",
owners=["string"],
parents=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
permission_resources=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
permissions=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
redirect_uris=["string"],
renew_client_secret=False,
response_types=["string"],
revocation_timestamp="string",
revoke=False,
roles=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
scopes=[{
"account_access_control_id": "string",
"additional_properties": "string",
"class_id": "string",
"object_type": "string",
"request_identifier": "string",
"switched_from_accounts": [{
"account_id": "string",
"additional_properties": "string",
"class_id": "string",
"object_type": "string",
"permission_id": "string",
}],
"switched_to_accounts": [{
"account_id": "string",
"additional_properties": "string",
"class_id": "string",
"object_type": "string",
"permission_id": "string",
}],
}],
security_holders=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
shared_scope="string",
show_consent_screen=False,
start_time="string",
tags=[{
"additional_properties": "string",
"key": "string",
"value": "string",
}],
token_expiry="string",
users=[{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
version_contexts=[{
"additional_properties": "string",
"class_id": "string",
"interested_mos": [{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
"marked_for_deletion": False,
"nr_version": "string",
"object_type": "string",
"ref_mos": [{
"additional_properties": "string",
"class_id": "string",
"moid": "string",
"object_type": "string",
"selector": "string",
}],
"timestamp": "string",
"version_type": "string",
}])
const iamAppRegistrationResource = new intersight.IamAppRegistration("iamAppRegistrationResource", {
accountMoid: "string",
accounts: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
additionalProperties: "string",
adminStatus: "string",
ancestors: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
classId: "string",
clientApplications: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
clientId: "string",
clientName: "string",
clientSecret: "string",
clientType: "string",
createTime: "string",
description: "string",
domainGroupMoid: "string",
entityId: "string",
expiryDateTime: "string",
grantTypes: ["string"],
iamAppRegistrationId: "string",
isNeverExpiring: false,
lastUsedIp: "string",
lastUsedTime: "string",
modTime: "string",
moid: "string",
oauthTokens: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
objectType: "string",
operStatus: "string",
owners: ["string"],
parents: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
permissionResources: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
permissions: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
redirectUris: ["string"],
renewClientSecret: false,
responseTypes: ["string"],
revocationTimestamp: "string",
revoke: false,
roles: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
scopes: [{
accountAccessControlId: "string",
additionalProperties: "string",
classId: "string",
objectType: "string",
requestIdentifier: "string",
switchedFromAccounts: [{
accountId: "string",
additionalProperties: "string",
classId: "string",
objectType: "string",
permissionId: "string",
}],
switchedToAccounts: [{
accountId: "string",
additionalProperties: "string",
classId: "string",
objectType: "string",
permissionId: "string",
}],
}],
securityHolders: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
sharedScope: "string",
showConsentScreen: false,
startTime: "string",
tags: [{
additionalProperties: "string",
key: "string",
value: "string",
}],
tokenExpiry: "string",
users: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
versionContexts: [{
additionalProperties: "string",
classId: "string",
interestedMos: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
markedForDeletion: false,
nrVersion: "string",
objectType: "string",
refMos: [{
additionalProperties: "string",
classId: "string",
moid: "string",
objectType: "string",
selector: "string",
}],
timestamp: "string",
versionType: "string",
}],
});
type: intersight:IamAppRegistration
properties:
accountMoid: string
accounts:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
additionalProperties: string
adminStatus: string
ancestors:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
classId: string
clientApplications:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
clientId: string
clientName: string
clientSecret: string
clientType: string
createTime: string
description: string
domainGroupMoid: string
entityId: string
expiryDateTime: string
grantTypes:
- string
iamAppRegistrationId: string
isNeverExpiring: false
lastUsedIp: string
lastUsedTime: string
modTime: string
moid: string
oauthTokens:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
objectType: string
operStatus: string
owners:
- string
parents:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
permissionResources:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
permissions:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
redirectUris:
- string
renewClientSecret: false
responseTypes:
- string
revocationTimestamp: string
revoke: false
roles:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
scopes:
- accountAccessControlId: string
additionalProperties: string
classId: string
objectType: string
requestIdentifier: string
switchedFromAccounts:
- accountId: string
additionalProperties: string
classId: string
objectType: string
permissionId: string
switchedToAccounts:
- accountId: string
additionalProperties: string
classId: string
objectType: string
permissionId: string
securityHolders:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
sharedScope: string
showConsentScreen: false
startTime: string
tags:
- additionalProperties: string
key: string
value: string
tokenExpiry: string
users:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
versionContexts:
- additionalProperties: string
classId: string
interestedMos:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
markedForDeletion: false
nrVersion: string
objectType: string
refMos:
- additionalProperties: string
classId: string
moid: string
objectType: string
selector: string
timestamp: string
versionType: string
IamAppRegistration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The IamAppRegistration resource accepts the following input properties:
- Account
Moid string - (ReadOnly) The Account ID for this managed object.
- Accounts
List<Iam
App Registration Account> - (ReadOnly) A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Additional
Properties string - Admin
Status 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<Iam
App Registration Ancestor> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Class
Id 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.
- Client
Applications List<IamApp Registration Client Application> - (ReadOnly) A reference to a iamAbstractClientApplication resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Client
Id string - (ReadOnly) A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.
- Client
Name string - App Registration name specified by user.
- Client
Secret string - The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.
- Client
Type 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. - Create
Time string - (ReadOnly) The time when this managed object was created.
- Description string
- Description of the application.
- Domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- Entity
Id string - (ReadOnly) EntityId holds the Id of the client application that is using this AppRegistration.
- Expiry
Date stringTime - 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 List<string> - (Array of schema.TypeString) -
- Iam
App stringRegistration Id - Is
Never boolExpiring - Used to mark the App Registration as a never-expiring App Registration.
- Last
Used stringIp - (ReadOnly) The ip address from which the App Registration was last used.
- Last
Used stringTime - (ReadOnly) The time at which the App Registration was last used. It is updated every 24 hours.
- Mod
Time string - (ReadOnly) The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Oauth
Tokens List<IamApp Registration Oauth Token> - (ReadOnly) An array of relationships to iamOAuthToken resources. This complex property has following sub-properties:
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Oper
Status string - (ReadOnly) 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>
- (Array of schema.TypeString) -(ReadOnly)
- Parents
List<Iam
App Registration Parent> - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Permission
Resources List<IamApp Registration Permission Resource> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Permissions
List<Iam
App Registration Permission> - (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Redirect
Uris List<string> - (Array of schema.TypeString) -
- Renew
Client boolSecret - Set value to true to renew the client-secret. Applicable to client_credentials grant type.
- Response
Types List<string> - (Array of schema.TypeString) -
- Revocation
Timestamp string - (ReadOnly) 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<Iam
App Registration Role> - An array of relationships to iamRole resources. This complex property has following sub-properties:
- Scopes
List<Iam
App Registration Scope> - (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
- Security
Holders List<IamApp Registration Security Holder> - (ReadOnly) A reference to a iamSecurityHolder resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- string
- (ReadOnly) 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 boolScreen - 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 string - (ReadOnly) 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.
- List<Iam
App Registration Tag> - This complex property has following sub-properties:
- Token
Expiry string - (ReadOnly) 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<Iam
App Registration User> - (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Version
Contexts List<IamApp Registration Version Context> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- Account
Moid string - (ReadOnly) The Account ID for this managed object.
- Accounts
[]Iam
App Registration Account Args - (ReadOnly) A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Additional
Properties string - Admin
Status 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
[]Iam
App Registration Ancestor Args - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Class
Id 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.
- Client
Applications []IamApp Registration Client Application Args - (ReadOnly) A reference to a iamAbstractClientApplication resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Client
Id string - (ReadOnly) A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.
- Client
Name string - App Registration name specified by user.
- Client
Secret string - The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.
- Client
Type 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. - Create
Time string - (ReadOnly) The time when this managed object was created.
- Description string
- Description of the application.
- Domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- Entity
Id string - (ReadOnly) EntityId holds the Id of the client application that is using this AppRegistration.
- Expiry
Date stringTime - 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 []string - (Array of schema.TypeString) -
- Iam
App stringRegistration Id - Is
Never boolExpiring - Used to mark the App Registration as a never-expiring App Registration.
- Last
Used stringIp - (ReadOnly) The ip address from which the App Registration was last used.
- Last
Used stringTime - (ReadOnly) The time at which the App Registration was last used. It is updated every 24 hours.
- Mod
Time string - (ReadOnly) The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Oauth
Tokens []IamApp Registration Oauth Token Args - (ReadOnly) An array of relationships to iamOAuthToken resources. This complex property has following sub-properties:
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Oper
Status string - (ReadOnly) 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
- (Array of schema.TypeString) -(ReadOnly)
- Parents
[]Iam
App Registration Parent Args - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Permission
Resources []IamApp Registration Permission Resource Args - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Permissions
[]Iam
App Registration Permission Args - (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Redirect
Uris []string - (Array of schema.TypeString) -
- Renew
Client boolSecret - Set value to true to renew the client-secret. Applicable to client_credentials grant type.
- Response
Types []string - (Array of schema.TypeString) -
- Revocation
Timestamp string - (ReadOnly) 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
[]Iam
App Registration Role Args - An array of relationships to iamRole resources. This complex property has following sub-properties:
- Scopes
[]Iam
App Registration Scope Args - (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
- Security
Holders []IamApp Registration Security Holder Args - (ReadOnly) A reference to a iamSecurityHolder resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- string
- (ReadOnly) 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 boolScreen - 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 string - (ReadOnly) 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.
- []Iam
App Registration Tag Args - This complex property has following sub-properties:
- Token
Expiry string - (ReadOnly) 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
[]Iam
App Registration User Args - (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Version
Contexts []IamApp Registration Version Context Args - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- account
Moid String - (ReadOnly) The Account ID for this managed object.
- accounts
List<Iam
App Registration Account> - (ReadOnly) A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- additional
Properties String - admin
Status 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<Iam
App Registration Ancestor> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- class
Id 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.
- client
Applications List<IamApp Registration Client Application> - (ReadOnly) A reference to a iamAbstractClientApplication resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- client
Id String - (ReadOnly) A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.
- client
Name String - App Registration name specified by user.
- client
Secret String - The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.
- client
Type 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. - create
Time String - (ReadOnly) The time when this managed object was created.
- description String
- Description of the application.
- domain
Group StringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- entity
Id String - (ReadOnly) EntityId holds the Id of the client application that is using this AppRegistration.
- expiry
Date StringTime - 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 List<String> - (Array of schema.TypeString) -
- iam
App StringRegistration Id - is
Never BooleanExpiring - Used to mark the App Registration as a never-expiring App Registration.
- last
Used StringIp - (ReadOnly) The ip address from which the App Registration was last used.
- last
Used StringTime - (ReadOnly) The time at which the App Registration was last used. It is updated every 24 hours.
- mod
Time String - (ReadOnly) The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- oauth
Tokens List<IamApp Registration Oauth Token> - (ReadOnly) An array of relationships to iamOAuthToken resources. This complex property has following sub-properties:
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- oper
Status String - (ReadOnly) 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>
- (Array of schema.TypeString) -(ReadOnly)
- parents
List<Iam
App Registration Parent> - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- permission
Resources List<IamApp Registration Permission Resource> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions
List<Iam
App Registration Permission> - (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- redirect
Uris List<String> - (Array of schema.TypeString) -
- renew
Client BooleanSecret - Set value to true to renew the client-secret. Applicable to client_credentials grant type.
- response
Types List<String> - (Array of schema.TypeString) -
- revocation
Timestamp String - (ReadOnly) 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<Iam
App Registration Role> - An array of relationships to iamRole resources. This complex property has following sub-properties:
- scopes
List<Iam
App Registration Scope> - (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
- security
Holders List<IamApp Registration Security Holder> - (ReadOnly) A reference to a iamSecurityHolder resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- String
- (ReadOnly) 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 BooleanScreen - 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 String - (ReadOnly) 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.
- List<Iam
App Registration Tag> - This complex property has following sub-properties:
- token
Expiry String - (ReadOnly) 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<Iam
App Registration User> - (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- version
Contexts List<IamApp Registration Version Context> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- account
Moid string - (ReadOnly) The Account ID for this managed object.
- accounts
Iam
App Registration Account[] - (ReadOnly) A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- additional
Properties string - admin
Status 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
Iam
App Registration Ancestor[] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- class
Id 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.
- client
Applications IamApp Registration Client Application[] - (ReadOnly) A reference to a iamAbstractClientApplication resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- client
Id string - (ReadOnly) A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.
- client
Name string - App Registration name specified by user.
- client
Secret string - The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.
- client
Type 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. - create
Time string - (ReadOnly) The time when this managed object was created.
- description string
- Description of the application.
- domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- entity
Id string - (ReadOnly) EntityId holds the Id of the client application that is using this AppRegistration.
- expiry
Date stringTime - 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 string[] - (Array of schema.TypeString) -
- iam
App stringRegistration Id - is
Never booleanExpiring - Used to mark the App Registration as a never-expiring App Registration.
- last
Used stringIp - (ReadOnly) The ip address from which the App Registration was last used.
- last
Used stringTime - (ReadOnly) The time at which the App Registration was last used. It is updated every 24 hours.
- mod
Time string - (ReadOnly) The time when this managed object was last modified.
- moid string
- The unique identifier of this Managed Object instance.
- oauth
Tokens IamApp Registration Oauth Token[] - (ReadOnly) An array of relationships to iamOAuthToken resources. This complex property has following sub-properties:
- object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- oper
Status string - (ReadOnly) 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[]
- (Array of schema.TypeString) -(ReadOnly)
- parents
Iam
App Registration Parent[] - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- permission
Resources IamApp Registration Permission Resource[] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions
Iam
App Registration Permission[] - (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- redirect
Uris string[] - (Array of schema.TypeString) -
- renew
Client booleanSecret - Set value to true to renew the client-secret. Applicable to client_credentials grant type.
- response
Types string[] - (Array of schema.TypeString) -
- revocation
Timestamp string - (ReadOnly) 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
Iam
App Registration Role[] - An array of relationships to iamRole resources. This complex property has following sub-properties:
- scopes
Iam
App Registration Scope[] - (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
- security
Holders IamApp Registration Security Holder[] - (ReadOnly) A reference to a iamSecurityHolder resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- string
- (ReadOnly) 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 booleanScreen - 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 string - (ReadOnly) 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.
- Iam
App Registration Tag[] - This complex property has following sub-properties:
- token
Expiry string - (ReadOnly) 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
Iam
App Registration User[] - (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- version
Contexts IamApp Registration Version Context[] - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- account_
moid str - (ReadOnly) The Account ID for this managed object.
- accounts
Sequence[Iam
App Registration Account Args] - (ReadOnly) A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- 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[Iam
App Registration Ancestor Args] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- 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.
- client_
applications Sequence[IamApp Registration Client Application Args] - (ReadOnly) A reference to a iamAbstractClientApplication resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- client_
id str - (ReadOnly) 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 - (ReadOnly) The time when this managed object was created.
- description str
- Description of the application.
- domain_
group_ strmoid - (ReadOnly) The DomainGroup ID for this managed object.
- entity_
id str - (ReadOnly) EntityId holds the Id of the client application that is using this AppRegistration.
- expiry_
date_ strtime - 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] - (Array of schema.TypeString) -
- iam_
app_ strregistration_ id - is_
never_ boolexpiring - Used to mark the App Registration as a never-expiring App Registration.
- last_
used_ strip - (ReadOnly) The ip address from which the App Registration was last used.
- last_
used_ strtime - (ReadOnly) The time at which the App Registration was last used. It is updated every 24 hours.
- mod_
time str - (ReadOnly) The time when this managed object was last modified.
- moid str
- The unique identifier of this Managed Object instance.
- oauth_
tokens Sequence[IamApp Registration Oauth Token Args] - (ReadOnly) An array of relationships to iamOAuthToken resources. This complex property has following sub-properties:
- object_
type str - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- oper_
status str - (ReadOnly) 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]
- (Array of schema.TypeString) -(ReadOnly)
- parents
Sequence[Iam
App Registration Parent Args] - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- permission_
resources Sequence[IamApp Registration Permission Resource Args] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions
Sequence[Iam
App Registration Permission Args] - (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- redirect_
uris Sequence[str] - (Array of schema.TypeString) -
- renew_
client_ boolsecret - Set value to true to renew the client-secret. Applicable to client_credentials grant type.
- response_
types Sequence[str] - (Array of schema.TypeString) -
- revocation_
timestamp str - (ReadOnly) 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[Iam
App Registration Role Args] - An array of relationships to iamRole resources. This complex property has following sub-properties:
- scopes
Sequence[Iam
App Registration Scope Args] - (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
- security_
holders Sequence[IamApp Registration Security Holder Args] - (ReadOnly) A reference to a iamSecurityHolder resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- str
- (ReadOnly) 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_ boolscreen - 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 - (ReadOnly) 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.
- Sequence[Iam
App Registration Tag Args] - This complex property has following sub-properties:
- token_
expiry str - (ReadOnly) 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
Sequence[Iam
App Registration User Args] - (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- version_
contexts Sequence[IamApp Registration Version Context Args] - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- account
Moid String - (ReadOnly) The Account ID for this managed object.
- accounts List<Property Map>
- (ReadOnly) A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- additional
Properties String - admin
Status 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>
- (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- class
Id 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.
- client
Applications List<Property Map> - (ReadOnly) A reference to a iamAbstractClientApplication resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- client
Id String - (ReadOnly) A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.
- client
Name String - App Registration name specified by user.
- client
Secret String - The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.
- client
Type 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. - create
Time String - (ReadOnly) The time when this managed object was created.
- description String
- Description of the application.
- domain
Group StringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- entity
Id String - (ReadOnly) EntityId holds the Id of the client application that is using this AppRegistration.
- expiry
Date StringTime - 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 List<String> - (Array of schema.TypeString) -
- iam
App StringRegistration Id - is
Never BooleanExpiring - Used to mark the App Registration as a never-expiring App Registration.
- last
Used StringIp - (ReadOnly) The ip address from which the App Registration was last used.
- last
Used StringTime - (ReadOnly) The time at which the App Registration was last used. It is updated every 24 hours.
- mod
Time String - (ReadOnly) The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- oauth
Tokens List<Property Map> - (ReadOnly) An array of relationships to iamOAuthToken resources. This complex property has following sub-properties:
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- oper
Status String - (ReadOnly) 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>
- (Array of schema.TypeString) -(ReadOnly)
- parents List<Property Map>
- (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- permission
Resources List<Property Map> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions List<Property Map>
- (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- redirect
Uris List<String> - (Array of schema.TypeString) -
- renew
Client BooleanSecret - Set value to true to renew the client-secret. Applicable to client_credentials grant type.
- response
Types List<String> - (Array of schema.TypeString) -
- revocation
Timestamp String - (ReadOnly) 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>
- An array of relationships to iamRole resources. This complex property has following sub-properties:
- scopes List<Property Map>
- (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
- security
Holders List<Property Map> - (ReadOnly) A reference to a iamSecurityHolder resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- String
- (ReadOnly) 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 BooleanScreen - 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 String - (ReadOnly) 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.
- List<Property Map>
- This complex property has following sub-properties:
- token
Expiry String - (ReadOnly) 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<Property Map>
- (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- version
Contexts List<Property Map> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the IamAppRegistration resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing IamAppRegistration Resource
Get an existing IamAppRegistration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: IamAppRegistrationState, opts?: CustomResourceOptions): IamAppRegistration
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_moid: Optional[str] = None,
accounts: Optional[Sequence[IamAppRegistrationAccountArgs]] = None,
additional_properties: Optional[str] = None,
admin_status: Optional[str] = None,
ancestors: Optional[Sequence[IamAppRegistrationAncestorArgs]] = None,
class_id: Optional[str] = None,
client_applications: Optional[Sequence[IamAppRegistrationClientApplicationArgs]] = None,
client_id: Optional[str] = None,
client_name: Optional[str] = None,
client_secret: Optional[str] = None,
client_type: Optional[str] = None,
create_time: Optional[str] = None,
description: Optional[str] = None,
domain_group_moid: Optional[str] = None,
entity_id: Optional[str] = None,
expiry_date_time: Optional[str] = None,
grant_types: Optional[Sequence[str]] = None,
iam_app_registration_id: Optional[str] = None,
is_never_expiring: Optional[bool] = None,
last_used_ip: Optional[str] = None,
last_used_time: Optional[str] = None,
mod_time: Optional[str] = None,
moid: Optional[str] = None,
oauth_tokens: Optional[Sequence[IamAppRegistrationOauthTokenArgs]] = None,
object_type: Optional[str] = None,
oper_status: Optional[str] = None,
owners: Optional[Sequence[str]] = None,
parents: Optional[Sequence[IamAppRegistrationParentArgs]] = None,
permission_resources: Optional[Sequence[IamAppRegistrationPermissionResourceArgs]] = None,
permissions: Optional[Sequence[IamAppRegistrationPermissionArgs]] = None,
redirect_uris: Optional[Sequence[str]] = None,
renew_client_secret: Optional[bool] = None,
response_types: Optional[Sequence[str]] = None,
revocation_timestamp: Optional[str] = None,
revoke: Optional[bool] = None,
roles: Optional[Sequence[IamAppRegistrationRoleArgs]] = None,
scopes: Optional[Sequence[IamAppRegistrationScopeArgs]] = None,
security_holders: Optional[Sequence[IamAppRegistrationSecurityHolderArgs]] = None,
shared_scope: Optional[str] = None,
show_consent_screen: Optional[bool] = None,
start_time: Optional[str] = None,
tags: Optional[Sequence[IamAppRegistrationTagArgs]] = None,
token_expiry: Optional[str] = None,
users: Optional[Sequence[IamAppRegistrationUserArgs]] = None,
version_contexts: Optional[Sequence[IamAppRegistrationVersionContextArgs]] = None) -> IamAppRegistration
func GetIamAppRegistration(ctx *Context, name string, id IDInput, state *IamAppRegistrationState, opts ...ResourceOption) (*IamAppRegistration, error)
public static IamAppRegistration Get(string name, Input<string> id, IamAppRegistrationState? state, CustomResourceOptions? opts = null)
public static IamAppRegistration get(String name, Output<String> id, IamAppRegistrationState state, CustomResourceOptions options)
resources: _: type: intersight:IamAppRegistration get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Account
Moid string - (ReadOnly) The Account ID for this managed object.
- Accounts
List<Iam
App Registration Account> - (ReadOnly) A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Additional
Properties string - Admin
Status 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<Iam
App Registration Ancestor> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Class
Id 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.
- Client
Applications List<IamApp Registration Client Application> - (ReadOnly) A reference to a iamAbstractClientApplication resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Client
Id string - (ReadOnly) A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.
- Client
Name string - App Registration name specified by user.
- Client
Secret string - The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.
- Client
Type 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. - Create
Time string - (ReadOnly) The time when this managed object was created.
- Description string
- Description of the application.
- Domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- Entity
Id string - (ReadOnly) EntityId holds the Id of the client application that is using this AppRegistration.
- Expiry
Date stringTime - 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 List<string> - (Array of schema.TypeString) -
- Iam
App stringRegistration Id - Is
Never boolExpiring - Used to mark the App Registration as a never-expiring App Registration.
- Last
Used stringIp - (ReadOnly) The ip address from which the App Registration was last used.
- Last
Used stringTime - (ReadOnly) The time at which the App Registration was last used. It is updated every 24 hours.
- Mod
Time string - (ReadOnly) The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Oauth
Tokens List<IamApp Registration Oauth Token> - (ReadOnly) An array of relationships to iamOAuthToken resources. This complex property has following sub-properties:
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Oper
Status string - (ReadOnly) 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>
- (Array of schema.TypeString) -(ReadOnly)
- Parents
List<Iam
App Registration Parent> - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Permission
Resources List<IamApp Registration Permission Resource> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Permissions
List<Iam
App Registration Permission> - (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Redirect
Uris List<string> - (Array of schema.TypeString) -
- Renew
Client boolSecret - Set value to true to renew the client-secret. Applicable to client_credentials grant type.
- Response
Types List<string> - (Array of schema.TypeString) -
- Revocation
Timestamp string - (ReadOnly) 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<Iam
App Registration Role> - An array of relationships to iamRole resources. This complex property has following sub-properties:
- Scopes
List<Iam
App Registration Scope> - (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
- Security
Holders List<IamApp Registration Security Holder> - (ReadOnly) A reference to a iamSecurityHolder resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- string
- (ReadOnly) 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 boolScreen - 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 string - (ReadOnly) 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.
- List<Iam
App Registration Tag> - This complex property has following sub-properties:
- Token
Expiry string - (ReadOnly) 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<Iam
App Registration User> - (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Version
Contexts List<IamApp Registration Version Context> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- Account
Moid string - (ReadOnly) The Account ID for this managed object.
- Accounts
[]Iam
App Registration Account Args - (ReadOnly) A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Additional
Properties string - Admin
Status 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
[]Iam
App Registration Ancestor Args - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Class
Id 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.
- Client
Applications []IamApp Registration Client Application Args - (ReadOnly) A reference to a iamAbstractClientApplication resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Client
Id string - (ReadOnly) A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.
- Client
Name string - App Registration name specified by user.
- Client
Secret string - The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.
- Client
Type 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. - Create
Time string - (ReadOnly) The time when this managed object was created.
- Description string
- Description of the application.
- Domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- Entity
Id string - (ReadOnly) EntityId holds the Id of the client application that is using this AppRegistration.
- Expiry
Date stringTime - 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 []string - (Array of schema.TypeString) -
- Iam
App stringRegistration Id - Is
Never boolExpiring - Used to mark the App Registration as a never-expiring App Registration.
- Last
Used stringIp - (ReadOnly) The ip address from which the App Registration was last used.
- Last
Used stringTime - (ReadOnly) The time at which the App Registration was last used. It is updated every 24 hours.
- Mod
Time string - (ReadOnly) The time when this managed object was last modified.
- Moid string
- The unique identifier of this Managed Object instance.
- Oauth
Tokens []IamApp Registration Oauth Token Args - (ReadOnly) An array of relationships to iamOAuthToken resources. This complex property has following sub-properties:
- Object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- Oper
Status string - (ReadOnly) 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
- (Array of schema.TypeString) -(ReadOnly)
- Parents
[]Iam
App Registration Parent Args - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Permission
Resources []IamApp Registration Permission Resource Args - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- Permissions
[]Iam
App Registration Permission Args - (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Redirect
Uris []string - (Array of schema.TypeString) -
- Renew
Client boolSecret - Set value to true to renew the client-secret. Applicable to client_credentials grant type.
- Response
Types []string - (Array of schema.TypeString) -
- Revocation
Timestamp string - (ReadOnly) 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
[]Iam
App Registration Role Args - An array of relationships to iamRole resources. This complex property has following sub-properties:
- Scopes
[]Iam
App Registration Scope Args - (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
- Security
Holders []IamApp Registration Security Holder Args - (ReadOnly) A reference to a iamSecurityHolder resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- string
- (ReadOnly) 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 boolScreen - 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 string - (ReadOnly) 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.
- []Iam
App Registration Tag Args - This complex property has following sub-properties:
- Token
Expiry string - (ReadOnly) 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
[]Iam
App Registration User Args - (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- Version
Contexts []IamApp Registration Version Context Args - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- account
Moid String - (ReadOnly) The Account ID for this managed object.
- accounts
List<Iam
App Registration Account> - (ReadOnly) A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- additional
Properties String - admin
Status 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<Iam
App Registration Ancestor> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- class
Id 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.
- client
Applications List<IamApp Registration Client Application> - (ReadOnly) A reference to a iamAbstractClientApplication resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- client
Id String - (ReadOnly) A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.
- client
Name String - App Registration name specified by user.
- client
Secret String - The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.
- client
Type 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. - create
Time String - (ReadOnly) The time when this managed object was created.
- description String
- Description of the application.
- domain
Group StringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- entity
Id String - (ReadOnly) EntityId holds the Id of the client application that is using this AppRegistration.
- expiry
Date StringTime - 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 List<String> - (Array of schema.TypeString) -
- iam
App StringRegistration Id - is
Never BooleanExpiring - Used to mark the App Registration as a never-expiring App Registration.
- last
Used StringIp - (ReadOnly) The ip address from which the App Registration was last used.
- last
Used StringTime - (ReadOnly) The time at which the App Registration was last used. It is updated every 24 hours.
- mod
Time String - (ReadOnly) The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- oauth
Tokens List<IamApp Registration Oauth Token> - (ReadOnly) An array of relationships to iamOAuthToken resources. This complex property has following sub-properties:
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- oper
Status String - (ReadOnly) 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>
- (Array of schema.TypeString) -(ReadOnly)
- parents
List<Iam
App Registration Parent> - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- permission
Resources List<IamApp Registration Permission Resource> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions
List<Iam
App Registration Permission> - (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- redirect
Uris List<String> - (Array of schema.TypeString) -
- renew
Client BooleanSecret - Set value to true to renew the client-secret. Applicable to client_credentials grant type.
- response
Types List<String> - (Array of schema.TypeString) -
- revocation
Timestamp String - (ReadOnly) 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<Iam
App Registration Role> - An array of relationships to iamRole resources. This complex property has following sub-properties:
- scopes
List<Iam
App Registration Scope> - (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
- security
Holders List<IamApp Registration Security Holder> - (ReadOnly) A reference to a iamSecurityHolder resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- String
- (ReadOnly) 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 BooleanScreen - 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 String - (ReadOnly) 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.
- List<Iam
App Registration Tag> - This complex property has following sub-properties:
- token
Expiry String - (ReadOnly) 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<Iam
App Registration User> - (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- version
Contexts List<IamApp Registration Version Context> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- account
Moid string - (ReadOnly) The Account ID for this managed object.
- accounts
Iam
App Registration Account[] - (ReadOnly) A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- additional
Properties string - admin
Status 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
Iam
App Registration Ancestor[] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- class
Id 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.
- client
Applications IamApp Registration Client Application[] - (ReadOnly) A reference to a iamAbstractClientApplication resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- client
Id string - (ReadOnly) A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.
- client
Name string - App Registration name specified by user.
- client
Secret string - The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.
- client
Type 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. - create
Time string - (ReadOnly) The time when this managed object was created.
- description string
- Description of the application.
- domain
Group stringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- entity
Id string - (ReadOnly) EntityId holds the Id of the client application that is using this AppRegistration.
- expiry
Date stringTime - 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 string[] - (Array of schema.TypeString) -
- iam
App stringRegistration Id - is
Never booleanExpiring - Used to mark the App Registration as a never-expiring App Registration.
- last
Used stringIp - (ReadOnly) The ip address from which the App Registration was last used.
- last
Used stringTime - (ReadOnly) The time at which the App Registration was last used. It is updated every 24 hours.
- mod
Time string - (ReadOnly) The time when this managed object was last modified.
- moid string
- The unique identifier of this Managed Object instance.
- oauth
Tokens IamApp Registration Oauth Token[] - (ReadOnly) An array of relationships to iamOAuthToken resources. This complex property has following sub-properties:
- object
Type string - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- oper
Status string - (ReadOnly) 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[]
- (Array of schema.TypeString) -(ReadOnly)
- parents
Iam
App Registration Parent[] - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- permission
Resources IamApp Registration Permission Resource[] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions
Iam
App Registration Permission[] - (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- redirect
Uris string[] - (Array of schema.TypeString) -
- renew
Client booleanSecret - Set value to true to renew the client-secret. Applicable to client_credentials grant type.
- response
Types string[] - (Array of schema.TypeString) -
- revocation
Timestamp string - (ReadOnly) 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
Iam
App Registration Role[] - An array of relationships to iamRole resources. This complex property has following sub-properties:
- scopes
Iam
App Registration Scope[] - (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
- security
Holders IamApp Registration Security Holder[] - (ReadOnly) A reference to a iamSecurityHolder resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- string
- (ReadOnly) 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 booleanScreen - 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 string - (ReadOnly) 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.
- Iam
App Registration Tag[] - This complex property has following sub-properties:
- token
Expiry string - (ReadOnly) 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
Iam
App Registration User[] - (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- version
Contexts IamApp Registration Version Context[] - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- account_
moid str - (ReadOnly) The Account ID for this managed object.
- accounts
Sequence[Iam
App Registration Account Args] - (ReadOnly) A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- 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[Iam
App Registration Ancestor Args] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- 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.
- client_
applications Sequence[IamApp Registration Client Application Args] - (ReadOnly) A reference to a iamAbstractClientApplication resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- client_
id str - (ReadOnly) 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 - (ReadOnly) The time when this managed object was created.
- description str
- Description of the application.
- domain_
group_ strmoid - (ReadOnly) The DomainGroup ID for this managed object.
- entity_
id str - (ReadOnly) EntityId holds the Id of the client application that is using this AppRegistration.
- expiry_
date_ strtime - 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] - (Array of schema.TypeString) -
- iam_
app_ strregistration_ id - is_
never_ boolexpiring - Used to mark the App Registration as a never-expiring App Registration.
- last_
used_ strip - (ReadOnly) The ip address from which the App Registration was last used.
- last_
used_ strtime - (ReadOnly) The time at which the App Registration was last used. It is updated every 24 hours.
- mod_
time str - (ReadOnly) The time when this managed object was last modified.
- moid str
- The unique identifier of this Managed Object instance.
- oauth_
tokens Sequence[IamApp Registration Oauth Token Args] - (ReadOnly) An array of relationships to iamOAuthToken resources. This complex property has following sub-properties:
- object_
type str - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- oper_
status str - (ReadOnly) 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]
- (Array of schema.TypeString) -(ReadOnly)
- parents
Sequence[Iam
App Registration Parent Args] - (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- permission_
resources Sequence[IamApp Registration Permission Resource Args] - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions
Sequence[Iam
App Registration Permission Args] - (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- redirect_
uris Sequence[str] - (Array of schema.TypeString) -
- renew_
client_ boolsecret - Set value to true to renew the client-secret. Applicable to client_credentials grant type.
- response_
types Sequence[str] - (Array of schema.TypeString) -
- revocation_
timestamp str - (ReadOnly) 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[Iam
App Registration Role Args] - An array of relationships to iamRole resources. This complex property has following sub-properties:
- scopes
Sequence[Iam
App Registration Scope Args] - (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
- security_
holders Sequence[IamApp Registration Security Holder Args] - (ReadOnly) A reference to a iamSecurityHolder resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- str
- (ReadOnly) 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_ boolscreen - 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 - (ReadOnly) 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.
- Sequence[Iam
App Registration Tag Args] - This complex property has following sub-properties:
- token_
expiry str - (ReadOnly) 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
Sequence[Iam
App Registration User Args] - (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- version_
contexts Sequence[IamApp Registration Version Context Args] - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
- account
Moid String - (ReadOnly) The Account ID for this managed object.
- accounts List<Property Map>
- (ReadOnly) A reference to a iamAccount resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- additional
Properties String - admin
Status 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>
- (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- class
Id 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.
- client
Applications List<Property Map> - (ReadOnly) A reference to a iamAbstractClientApplication resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- client
Id String - (ReadOnly) A unique identifier for the OAuth2 client application.The client ID is auto-generated when the AppRegistration object is created.
- client
Name String - App Registration name specified by user.
- client
Secret String - The OAuth2 client secret.The value of this property is generated when grantType includes 'client-credentials'.Otherwise, no client-secret is generated.
- client
Type 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. - create
Time String - (ReadOnly) The time when this managed object was created.
- description String
- Description of the application.
- domain
Group StringMoid - (ReadOnly) The DomainGroup ID for this managed object.
- entity
Id String - (ReadOnly) EntityId holds the Id of the client application that is using this AppRegistration.
- expiry
Date StringTime - 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 List<String> - (Array of schema.TypeString) -
- iam
App StringRegistration Id - is
Never BooleanExpiring - Used to mark the App Registration as a never-expiring App Registration.
- last
Used StringIp - (ReadOnly) The ip address from which the App Registration was last used.
- last
Used StringTime - (ReadOnly) The time at which the App Registration was last used. It is updated every 24 hours.
- mod
Time String - (ReadOnly) The time when this managed object was last modified.
- moid String
- The unique identifier of this Managed Object instance.
- oauth
Tokens List<Property Map> - (ReadOnly) An array of relationships to iamOAuthToken resources. This complex property has following sub-properties:
- object
Type String - The fully-qualified name of the instantiated, concrete type. The value should be the same as the 'ClassId' property.
- oper
Status String - (ReadOnly) 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>
- (Array of schema.TypeString) -(ReadOnly)
- parents List<Property Map>
- (ReadOnly) A reference to a moBaseMo resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- permission
Resources List<Property Map> - (ReadOnly) An array of relationships to moBaseMo resources. This complex property has following sub-properties:
- permissions List<Property Map>
- (ReadOnly) A reference to a iamPermission resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- redirect
Uris List<String> - (Array of schema.TypeString) -
- renew
Client BooleanSecret - Set value to true to renew the client-secret. Applicable to client_credentials grant type.
- response
Types List<String> - (Array of schema.TypeString) -
- revocation
Timestamp String - (ReadOnly) 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>
- An array of relationships to iamRole resources. This complex property has following sub-properties:
- scopes List<Property Map>
- (ReadOnly) Scope holds a collection of account Id, permission Id to which the current session is scoped to. This complex property has following sub-properties:
- security
Holders List<Property Map> - (ReadOnly) A reference to a iamSecurityHolder resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- String
- (ReadOnly) 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 BooleanScreen - 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 String - (ReadOnly) 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.
- List<Property Map>
- This complex property has following sub-properties:
- token
Expiry String - (ReadOnly) 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<Property Map>
- (ReadOnly) A reference to a iamUser resource.When the $expand query parameter is specified, the referenced resource is returned inline. This complex property has following sub-properties:
- version
Contexts List<Property Map> - (ReadOnly) The versioning info for this managed object. This complex property has following sub-properties:
Supporting Types
IamAppRegistrationAccount, IamAppRegistrationAccountArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 - moid str
- The Moid of the referenced REST resource.
- 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.
IamAppRegistrationAncestor, IamAppRegistrationAncestorArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 - moid str
- The Moid of the referenced REST resource.
- 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.
IamAppRegistrationClientApplication, IamAppRegistrationClientApplicationArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 - moid str
- The Moid of the referenced REST resource.
- 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.
IamAppRegistrationOauthToken, IamAppRegistrationOauthTokenArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 - moid str
- The Moid of the referenced REST resource.
- 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.
IamAppRegistrationParent, IamAppRegistrationParentArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 - moid str
- The Moid of the referenced REST resource.
- 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.
IamAppRegistrationPermission, IamAppRegistrationPermissionArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 - moid str
- The Moid of the referenced REST resource.
- 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.
IamAppRegistrationPermissionResource, IamAppRegistrationPermissionResourceArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 - moid str
- The Moid of the referenced REST resource.
- 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.
IamAppRegistrationRole, IamAppRegistrationRoleArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 - moid str
- The Moid of the referenced REST resource.
- 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.
IamAppRegistrationScope, IamAppRegistrationScopeArgs
- Account
Access stringControl Id - (ReadOnly) Moid of the AccountAccessControl through which the access is given to switch scope.
- Additional
Properties string - Class
Id string - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Request
Identifier string - (ReadOnly) Stores the identifier of the issue for which user is trying to switch scope to another account.
- Switched
From List<IamAccounts App Registration Scope Switched From Account> - (ReadOnly) Permission for the Account from which user switched the scope. This complex property has following sub-properties:
- Switched
To List<IamAccounts App Registration Scope Switched To Account> - This complex property has following sub-properties:
- Account
Access stringControl Id - (ReadOnly) Moid of the AccountAccessControl through which the access is given to switch scope.
- Additional
Properties string - Class
Id string - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Request
Identifier string - (ReadOnly) Stores the identifier of the issue for which user is trying to switch scope to another account.
- Switched
From []IamAccounts App Registration Scope Switched From Account - (ReadOnly) Permission for the Account from which user switched the scope. This complex property has following sub-properties:
- Switched
To []IamAccounts App Registration Scope Switched To Account - This complex property has following sub-properties:
- account
Access StringControl Id - (ReadOnly) Moid of the AccountAccessControl through which the access is given to switch scope.
- additional
Properties String - class
Id String - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- request
Identifier String - (ReadOnly) Stores the identifier of the issue for which user is trying to switch scope to another account.
- switched
From List<IamAccounts App Registration Scope Switched From Account> - (ReadOnly) Permission for the Account from which user switched the scope. This complex property has following sub-properties:
- switched
To List<IamAccounts App Registration Scope Switched To Account> - This complex property has following sub-properties:
- account
Access stringControl Id - (ReadOnly) Moid of the AccountAccessControl through which the access is given to switch scope.
- additional
Properties string - class
Id string - object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- request
Identifier string - (ReadOnly) Stores the identifier of the issue for which user is trying to switch scope to another account.
- switched
From IamAccounts App Registration Scope Switched From Account[] - (ReadOnly) Permission for the Account from which user switched the scope. This complex property has following sub-properties:
- switched
To IamAccounts App Registration Scope Switched To Account[] - This complex property has following sub-properties:
- account_
access_ strcontrol_ id - (ReadOnly) Moid of the AccountAccessControl through which the access is given to switch scope.
- additional_
properties str - class_
id str - object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- request_
identifier str - (ReadOnly) Stores the identifier of the issue for which user is trying to switch scope to another account.
- switched_
from_ Sequence[Iamaccounts App Registration Scope Switched From Account] - (ReadOnly) Permission for the Account from which user switched the scope. This complex property has following sub-properties:
- switched_
to_ Sequence[Iamaccounts App Registration Scope Switched To Account] - This complex property has following sub-properties:
- account
Access StringControl Id - (ReadOnly) Moid of the AccountAccessControl through which the access is given to switch scope.
- additional
Properties String - class
Id String - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- request
Identifier String - (ReadOnly) Stores the identifier of the issue for which user is trying to switch scope to another account.
- switched
From List<Property Map>Accounts - (ReadOnly) Permission for the Account from which user switched the scope. This complex property has following sub-properties:
- switched
To List<Property Map>Accounts - This complex property has following sub-properties:
IamAppRegistrationScopeSwitchedFromAccount, IamAppRegistrationScopeSwitchedFromAccountArgs
- Account
Id string - (ReadOnly) Moid of the Account to/from which user switched the scope.
- Additional
Properties string - Class
Id string - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Permission
Id string - (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
- Account
Id string - (ReadOnly) Moid of the Account to/from which user switched the scope.
- Additional
Properties string - Class
Id string - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Permission
Id string - (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
- account
Id String - (ReadOnly) Moid of the Account to/from which user switched the scope.
- additional
Properties String - class
Id String - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- permission
Id String - (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
- account
Id string - (ReadOnly) Moid of the Account to/from which user switched the scope.
- additional
Properties string - class
Id string - object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- permission
Id string - (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
- account_
id str - (ReadOnly) Moid of the Account to/from which user switched the scope.
- additional_
properties str - class_
id str - object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- permission_
id str - (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
- account
Id String - (ReadOnly) Moid of the Account to/from which user switched the scope.
- additional
Properties String - class
Id String - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- permission
Id String - (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
IamAppRegistrationScopeSwitchedToAccount, IamAppRegistrationScopeSwitchedToAccountArgs
- Account
Id string - (ReadOnly) Moid of the Account to/from which user switched the scope.
- Additional
Properties string - Class
Id string - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Permission
Id string - (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
- Account
Id string - (ReadOnly) Moid of the Account to/from which user switched the scope.
- Additional
Properties string - Class
Id string - Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Permission
Id string - (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
- account
Id String - (ReadOnly) Moid of the Account to/from which user switched the scope.
- additional
Properties String - class
Id String - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- permission
Id String - (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
- account
Id string - (ReadOnly) Moid of the Account to/from which user switched the scope.
- additional
Properties string - class
Id string - object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- permission
Id string - (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
- account_
id str - (ReadOnly) Moid of the Account to/from which user switched the scope.
- additional_
properties str - class_
id str - object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- permission_
id str - (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
- account
Id String - (ReadOnly) Moid of the Account to/from which user switched the scope.
- additional
Properties String - class
Id String - object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- permission
Id String - (ReadOnly) Moid of the Permission for the Account to/from which user switched the scope.
IamAppRegistrationSecurityHolder, IamAppRegistrationSecurityHolderArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 - moid str
- The Moid of the referenced REST resource.
- 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.
IamAppRegistrationTag, IamAppRegistrationTagArgs
- Additional
Properties string - Key string
- The string representation of a tag key.
- Value string
- The string representation of a tag value.
- Additional
Properties string - Key string
- The string representation of a tag key.
- Value string
- The string representation of a tag value.
- additional
Properties String - key String
- The string representation of a tag key.
- value String
- The string representation of a tag value.
- additional
Properties string - key string
- The string representation of a tag key.
- value string
- The string representation of a tag value.
- additional_
properties str - key str
- The string representation of a tag key.
- value str
- The string representation of a tag value.
- additional
Properties String - key String
- The string representation of a tag key.
- value String
- The string representation of a tag value.
IamAppRegistrationUser, IamAppRegistrationUserArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 - moid str
- The Moid of the referenced REST resource.
- 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.
IamAppRegistrationVersionContext, IamAppRegistrationVersionContextArgs
- Additional
Properties string - Class
Id string - Interested
Mos List<IamApp Registration Version Context Interested Mo> - This complex property has following sub-properties:
- Marked
For boolDeletion - (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- Nr
Version string - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Ref
Mos List<IamApp Registration Version Context Ref Mo> - (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
- Timestamp string
- (ReadOnly) The time this versioned Managed Object was created.
- Version
Type string - (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.*
Modified
- Version created every time an object is modified.*Configured
- Version created every time an object is configured to the service profile.*Deployed
- Version created for objects related to a service profile when it is deployed.
- Additional
Properties string - Class
Id string - Interested
Mos []IamApp Registration Version Context Interested Mo - This complex property has following sub-properties:
- Marked
For boolDeletion - (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- Nr
Version string - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- Object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- Ref
Mos []IamApp Registration Version Context Ref Mo - (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
- Timestamp string
- (ReadOnly) The time this versioned Managed Object was created.
- Version
Type string - (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.*
Modified
- Version created every time an object is modified.*Configured
- Version created every time an object is configured to the service profile.*Deployed
- Version created for objects related to a service profile when it is deployed.
- additional
Properties String - class
Id String - interested
Mos List<IamApp Registration Version Context Interested Mo> - This complex property has following sub-properties:
- marked
For BooleanDeletion - (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- nr
Version String - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- ref
Mos List<IamApp Registration Version Context Ref Mo> - (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
- timestamp String
- (ReadOnly) The time this versioned Managed Object was created.
- version
Type String - (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.*
Modified
- Version created every time an object is modified.*Configured
- Version created every time an object is configured to the service profile.*Deployed
- Version created for objects related to a service profile when it is deployed.
- additional
Properties string - class
Id string - interested
Mos IamApp Registration Version Context Interested Mo[] - This complex property has following sub-properties:
- marked
For booleanDeletion - (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- nr
Version string - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type string - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- ref
Mos IamApp Registration Version Context Ref Mo[] - (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
- timestamp string
- (ReadOnly) The time this versioned Managed Object was created.
- version
Type string - (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.*
Modified
- Version created every time an object is modified.*Configured
- Version created every time an object is configured to the service profile.*Deployed
- Version created for objects related to a service profile when it is deployed.
- additional_
properties str - class_
id str - interested_
mos Sequence[IamApp Registration Version Context Interested Mo] - This complex property has following sub-properties:
- marked_
for_ booldeletion - (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- nr_
version str - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- object_
type str - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- ref_
mos Sequence[IamApp Registration Version Context Ref Mo] - (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
- timestamp str
- (ReadOnly) The time this versioned Managed Object was created.
- version_
type str - (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.*
Modified
- Version created every time an object is modified.*Configured
- Version created every time an object is configured to the service profile.*Deployed
- Version created for objects related to a service profile when it is deployed.
- additional
Properties String - class
Id String - interested
Mos List<Property Map> - This complex property has following sub-properties:
- marked
For BooleanDeletion - (ReadOnly) The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.
- nr
Version String - (ReadOnly) The version of the Managed Object, e.g. an incrementing number or a hash id.
- object
Type String - The fully-qualified name of the instantiated, concrete type.The value should be the same as the 'ClassId' property.
- ref
Mos List<Property Map> - (ReadOnly) A reference to the original Managed Object. This complex property has following sub-properties:
- timestamp String
- (ReadOnly) The time this versioned Managed Object was created.
- version
Type String - (ReadOnly) Specifies type of version. Currently the only supported value is \ Configured\ that is used to keep track of snapshots of policies and profiles that are intendedto be configured to target endpoints.*
Modified
- Version created every time an object is modified.*Configured
- Version created every time an object is configured to the service profile.*Deployed
- Version created for objects related to a service profile when it is deployed.
IamAppRegistrationVersionContextInterestedMo, IamAppRegistrationVersionContextInterestedMoArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 - moid str
- The Moid of the referenced REST resource.
- 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.
IamAppRegistrationVersionContextRefMo, IamAppRegistrationVersionContextRefMoArgs
- Additional
Properties string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - Class
Id string - Moid string
- The Moid of the referenced REST resource.
- Object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 string - class
Id string - moid string
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 - moid str
- The Moid of the referenced REST resource.
- 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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 String - class
Id String - moid String
- The Moid of the referenced REST resource.
- object
Type 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 maybe set instead of 'moid' by clients.1. If 'moid' is set this field is ignored.1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of theresource matching the filter expression and populates it in the MoRef that is part of the objectinstance 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'.
Import
intersight_iam_app_registration
can be imported using the Moid of the object, e.g.
$ pulumi import intersight:index/iamAppRegistration:IamAppRegistration example 1234567890987654321abcde
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- intersight ciscodevnet/terraform-provider-intersight
- License
- Notes
- This Pulumi package is based on the
intersight
Terraform Provider.