Skip to content

Commit 4514ae6

Browse files
chore: update MyOrganization API OAS artifacts (#1434)
Co-authored-by: auth0-docs-automation[bot] <266159893+auth0-docs-automation[bot]@users.noreply.github.com>
1 parent c2f1e5a commit 4514ae6

4 files changed

Lines changed: 82 additions & 13 deletions

File tree

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"oasVersion": "1.9395.0",
2+
"oasVersion": "1.9433.0",
33
"snippetVersion": "0.0.7"
44
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"oasVersion": "1.9395.0",
2+
"oasVersion": "1.9433.0",
33
"snippetVersion": "0.0.7"
44
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"oasVersion": "1.9395.0",
2+
"oasVersion": "1.9433.0",
33
"snippetVersion": "0.0.7"
44
}

main/docs/oas/myorganization/myorganization-api-oas.json

Lines changed: 79 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2966,6 +2966,15 @@
29662966
}
29672967
}
29682968
},
2969+
"GetUserPermissionsResponseExample": {
2970+
"value": {
2971+
"permissions": [
2972+
"read:my_org:permissions",
2973+
"read:my_org:configuration",
2974+
"update:my_org:identity_providers"
2975+
]
2976+
}
2977+
},
29692978
"GetAllowedApisResponseExample": {
29702979
"value": {
29712980
"apis": [
@@ -3314,6 +3323,17 @@
33143323
"pattern": "^created_at:(1|-1)$",
33153324
"default": "created_at:-1"
33163325
}
3326+
},
3327+
"UserPermissionsRequestQueryParameter": {
3328+
"in": "query",
3329+
"name": "permissions",
3330+
"required": true,
3331+
"description": "Comma-separated list of permissions to confirm the user's access.",
3332+
"schema": {
3333+
"type": "string",
3334+
"minLength": 1,
3335+
"maxLength": 1000
3336+
}
33173337
}
33183338
},
33193339
"requestBodies": {
@@ -4364,6 +4384,38 @@
43644384
}
43654385
}
43664386
},
4387+
"GetUserPermissionsResponse": {
4388+
"description": "User permissions successfully retrieved.",
4389+
"headers": {
4390+
"X-RateLimit-Limit": {
4391+
"$ref": "#/components/headers/X-RateLimit-Limit"
4392+
},
4393+
"X-RateLimit-Remaining": {
4394+
"$ref": "#/components/headers/X-RateLimit-Remaining"
4395+
},
4396+
"X-RateLimit-Reset": {
4397+
"$ref": "#/components/headers/X-RateLimit-Reset"
4398+
},
4399+
"Retry-After": {
4400+
"$ref": "#/components/headers/Retry-After"
4401+
},
4402+
"X-Auth0-Error-Kind": {
4403+
"$ref": "#/components/headers/X-Auth0-Error-Kind"
4404+
}
4405+
},
4406+
"content": {
4407+
"application/json": {
4408+
"schema": {
4409+
"$ref": "#/components/schemas/GetUserPermissionsResponseContent"
4410+
},
4411+
"examples": {
4412+
"getUserPermissionsResponseExample": {
4413+
"$ref": "#/components/examples/GetUserPermissionsResponseExample"
4414+
}
4415+
}
4416+
}
4417+
}
4418+
},
43674419
"GetAllowedApisResponse": {
43684420
"description": "Allowed APIs successfully retrieved.",
43694421
"headers": {
@@ -5355,6 +5407,21 @@
53555407
"GetIdpConfigurationResponseContent": {
53565408
"$ref": "#/components/schemas/IdentityProvidersConfig"
53575409
},
5410+
"GetUserPermissionsResponseContent": {
5411+
"type": "object",
5412+
"additionalProperties": false,
5413+
"properties": {
5414+
"permissions": {
5415+
"type": "array",
5416+
"items": {
5417+
"type": "string"
5418+
}
5419+
}
5420+
},
5421+
"required": [
5422+
"permissions"
5423+
]
5424+
},
53585425
"GetAllowedApisResponseContent": {
53595426
"type": "object",
53605427
"additionalProperties": false,
@@ -7183,14 +7250,6 @@
71837250
"readOnly": true,
71847251
"pattern": "^org_[A-Za-z0-9]{16}$"
71857252
},
7186-
"OrgDetailsThirdPartyClientAccessEnum": {
7187-
"type": "string",
7188-
"enum": [
7189-
"allow",
7190-
"block"
7191-
],
7192-
"description": "Whether third-party clients are allowed to access this organization."
7193-
},
71947253
"InvitationId": {
71957254
"type": "string",
71967255
"description": "The id of the member invitation",
@@ -7316,6 +7375,14 @@
73167375
"verification_host"
73177376
]
73187377
},
7378+
"OrgThirdPartyClientAccessEnum": {
7379+
"type": "string",
7380+
"description": "A valid third-party client access value",
7381+
"enum": [
7382+
"allow",
7383+
"block"
7384+
]
7385+
},
73197386
"BaseUserAttributeMapItem": {
73207387
"type": "object",
73217388
"properties": {
@@ -7888,7 +7955,8 @@
78887955
"create:my_org:client_grants": "Create client grants for client in organization",
78897956
"create:my_org:clients": "Create API clients for organization",
78907957
"read:my_org:clients": "Read API clients for organization",
7891-
"delete:my_org:clients": "Delete API clients for organization"
7958+
"delete:my_org:clients": "Delete API clients for organization",
7959+
"read:my_org:permissions": "Read permissions for a user"
78927960
}
78937961
}
78947962
}
@@ -7935,7 +8003,8 @@
79358003
"create:my_org:client_grants": "Create client grants for client in organization",
79368004
"create:my_org:clients": "Create API clients for organization",
79378005
"read:my_org:clients": "Read API clients for organization",
7938-
"delete:my_org:clients": "Delete API clients for organization"
8006+
"delete:my_org:clients": "Delete API clients for organization",
8007+
"read:my_org:permissions": "Read permissions for a user"
79398008
}
79408009
}
79418010
}

0 commit comments

Comments
 (0)