import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * This data source provides details about a specific Grant resource in Oracle Cloud Infrastructure Identity Domains service. * * Get a Grant * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testGrant = oci.identity.getDomainsGrant({ * grantId: testGrantOciIdentityDomainsGrant.id, * idcsEndpoint: testDomain.url, * attributeSets: ["all"], * attributes: "", * authorization: grantAuthorization, * resourceTypeSchemaVersion: grantResourceTypeSchemaVersion, * }); * ``` */ export declare function getDomainsGrant(args: GetDomainsGrantArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getDomainsGrant. */ export interface GetDomainsGrantArgs { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets?: string[]; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes?: string; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization?: string; /** * ID of the resource */ grantId: string; /** * The basic endpoint for the identity domain */ idcsEndpoint: string; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion?: string; } /** * A collection of values returned by getDomainsGrant. */ export interface GetDomainsGrantResult { /** * Application-Entitlement-Collection that is being granted. Each Grant must grant either an App or an App-Entitlement-Collection. */ readonly appEntitlementCollections: outputs.Identity.GetDomainsGrantAppEntitlementCollection[]; /** * Application that is being granted. Each Grant must grant either an App or an App-Entitlement-Collection. */ readonly apps: outputs.Identity.GetDomainsGrantApp[]; readonly attributeSets?: string[]; readonly attributes?: string; readonly authorization?: string; /** * Oracle Cloud Infrastructure Compartment Id (ocid) in which the resource lives. */ readonly compartmentOcid: string; /** * Unique key of grant, composed by combining a subset of app, entitlement, grantee, grantor and grantMechanism. Used to prevent duplicate Grants. */ readonly compositeKey: string; /** * A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long. */ readonly deleteInProgress: boolean; /** * Oracle Cloud Infrastructure Domain Id (ocid) in which the resource lives. */ readonly domainOcid: string; /** * The entitlement or privilege that is being granted */ readonly entitlements: outputs.Identity.GetDomainsGrantEntitlement[]; readonly grantId: string; /** * Each value of grantMechanism indicates how (or by what component) some App (or App-Entitlement) was granted. A customer or the UI should use only grantMechanism values that start with 'ADMINISTRATOR': * * 'ADMINISTRATOR_TO_USER' is for a direct grant to a specific User. * * 'ADMINISTRATOR_TO_GROUP' is for a grant to a specific Group, which results in indirect grants to Users who are members of that Group. * * 'ADMINISTRATOR_TO_APP' is for a grant to a specific App. The grantee (client) App gains access to the granted (server) App. */ readonly grantMechanism: string; /** * Store granted attribute-values as a string in Javascript Object Notation (JSON) format. */ readonly grantedAttributeValuesJson: string; /** * Grantee beneficiary. The grantee may be a User, Group, App or DynamicResourceGroup. */ readonly grantees: outputs.Identity.GetDomainsGrantGrantee[]; /** * User conferring the grant to the beneficiary */ readonly grantors: outputs.Identity.GetDomainsGrantGrantor[]; /** * Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier. */ readonly id: string; /** * The User or App who created the Resource */ readonly idcsCreatedBies: outputs.Identity.GetDomainsGrantIdcsCreatedBy[]; readonly idcsEndpoint: string; /** * The User or App who modified the Resource */ readonly idcsLastModifiedBies: outputs.Identity.GetDomainsGrantIdcsLastModifiedBy[]; /** * The release number when the resource was upgraded. */ readonly idcsLastUpgradedInRelease: string; /** * Each value of this attribute specifies an operation that only an internal client may perform on this particular resource. */ readonly idcsPreventedOperations: string[]; /** * If true, this Grant has been fulfilled successfully. */ readonly isFulfilled: boolean; /** * A complex attribute that contains resource metadata. All sub-attributes are OPTIONAL. */ readonly metas: outputs.Identity.GetDomainsGrantMeta[]; /** * Unique Oracle Cloud Infrastructure identifier for the SCIM Resource. */ readonly ocid: string; readonly resourceTypeSchemaVersion?: string; /** * REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \"enterprise\" extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. */ readonly schemas: string[]; /** * A list of tags on this resource. */ readonly tags: outputs.Identity.GetDomainsGrantTag[]; /** * Oracle Cloud Infrastructure Tenant Id (ocid) in which the resource lives. */ readonly tenancyOcid: string; } /** * This data source provides details about a specific Grant resource in Oracle Cloud Infrastructure Identity Domains service. * * Get a Grant * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testGrant = oci.identity.getDomainsGrant({ * grantId: testGrantOciIdentityDomainsGrant.id, * idcsEndpoint: testDomain.url, * attributeSets: ["all"], * attributes: "", * authorization: grantAuthorization, * resourceTypeSchemaVersion: grantResourceTypeSchemaVersion, * }); * ``` */ export declare function getDomainsGrantOutput(args: GetDomainsGrantOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getDomainsGrant. */ export interface GetDomainsGrantOutputArgs { /** * A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If 'attributes' query parameter is also available, union of the two is fetched. Valid values - all, always, never, request, default. Values are case-insensitive. */ attributeSets?: pulumi.Input[] | undefined>; /** * A comma-delimited string that specifies the names of resource attributes that should be returned in the response. By default, a response that contains resource attributes contains only attributes that are defined in the schema for that resource type as returned=always or returned=default. An attribute that is defined as returned=request is returned in a response only if the request specifies its name in the value of this query parameter. If a request specifies this query parameter, the response contains the attributes that this query parameter specifies, as well as any attribute that is defined as returned=always. */ attributes?: pulumi.Input; /** * The Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested. */ authorization?: pulumi.Input; /** * ID of the resource */ grantId: pulumi.Input; /** * The basic endpoint for the identity domain */ idcsEndpoint: pulumi.Input; /** * An endpoint-specific schema version number to use in the Request. Allowed version values are Earliest Version or Latest Version as specified in each REST API endpoint description, or any sequential number inbetween. All schema attributes/body parameters are a part of version 1. After version 1, any attributes added or deprecated will be tagged with the version that they were added to or deprecated in. If no version is provided, the latest schema version is returned. */ resourceTypeSchemaVersion?: pulumi.Input; } //# sourceMappingURL=getDomainsGrant.d.ts.map