AuthenticationAmazon Web ServicesIdentityOAuthOpenID ConnectSAMLUser ManagementFederated IdentityIdentity Federation
GroupType is a JSON Structure definition published by Amazon Cognito, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-group-type-structure.json",
"name": "GroupType",
"description": "The group type.",
"type": "object",
"properties": {
"GroupName": {
"allOf": [
{
"$ref": "#/components/schemas/GroupNameType"
},
{
"description": "The name of the group."
}
]
},
"UserPoolId": {
"allOf": [
{
"$ref": "#/components/schemas/UserPoolIdType"
},
{
"description": "The user pool ID for the user pool."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/DescriptionType"
},
{
"description": "A string containing the description of the group."
}
]
},
"RoleArn": {
"allOf": [
{
"$ref": "#/components/schemas/ArnType"
},
{
"description": "The role Amazon Resource Name (ARN) for the group."
}
]
},
"Precedence": {
"allOf": [
{
"$ref": "#/components/schemas/PrecedenceType"
},
{
"description": "<p>A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower <code>Precedence</code> values take precedence over groups with higher ornull <code>Precedence</code> values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims.</p> <p>Two groups can have the same <code>Precedence</code> value. If this happens, neither group takes precedence over the other. If two groups with the same <code>Precedence</code> have the same role ARN, that role is used in the <code>cognito:preferred_role</code> claim in tokens for users in each group. If the two groups have different role ARNs, the <code>cognito:preferred_role</code> claim isn't set in users' tokens.</p> <p>The default <code>Precedence</code> value is null.</p>"
}
]
},
"LastModifiedDate": {
"allOf": [
{
"$ref": "#/components/schemas/DateType"
},
{
"description": "The date and time, in <a href=\"https://www.iso.org/iso-8601-date-and-time-format.html\">ISO 8601</a> format, when the item was modified."
}
]
},
"CreationDate": {
"allOf": [
{
"$ref": "#/components/schemas/DateType"
},
{
"description": "The date and time, in <a href=\"https://www.iso.org/iso-8601-date-and-time-format.html\">ISO 8601</a> format, when the item was created."
}
]
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.